README.md 9.79 KB
Newer Older
Chocobozzz's avatar
Chocobozzz committed
1
<h1 align="center">
Rigel Kent's avatar
Rigel Kent committed
2
  <a href="https://joinpeertube.org">
3 4
    <img src="https://joinpeertube.org/img/brand.png" alt="PeerTube">
  </a>
Chocobozzz's avatar
Chocobozzz committed
5
</h1>
Chocobozzz's avatar
Spawn  
Chocobozzz committed
6

Rigel Kent's avatar
Rigel Kent committed
7 8 9
<p align=center>
  <strong><a href="https://joinpeertube.org">Website</a></strong>
  | <strong><a href="https://instances.joinpeertube.org">Join an instance</a></strong>
10
  | <strong><a href="#package-create-your-own-instance">Create an instance</a></strong>
Rigel Kent's avatar
Rigel Kent committed
11
  | <strong><a href="#contact">Chat with us</a></strong>
12
  | <strong><a href="https://framasoft.org/en/#soutenir">Donate</a></strong>
Rigel Kent's avatar
Rigel Kent committed
13 14
</p>

15
<p align="center">
16
Be part of a network of multiple small federated, interoperable video hosting providers. Follow video creators and create videos. No vendor lock-in. All on a platform that is community-owned and ad-free.
17
</p>
18

Chocobozzz's avatar
Chocobozzz committed
19 20 21 22 23 24
<p align="center">
  <strong>Developed with &#10084; by <a href="https://framasoft.org">Framasoft</a></strong>
</p>

<p align="center">
  <a href="https://framasoft.org">
25
    <img width="150px" src="https://lutim.cpy.re/FeRgHH8r.png" alt="Framasoft logo"/>
Chocobozzz's avatar
Chocobozzz committed
26 27 28
  </a>
</p>

Chocobozzz's avatar
Chocobozzz committed
29 30
<p align="center">
  <strong>Client</strong>
Chocobozzz's avatar
Chocobozzz committed
31

Chocobozzz's avatar
Chocobozzz committed
32
  <br />
Chocobozzz's avatar
Spawn  
Chocobozzz committed
33

Chocobozzz's avatar
Chocobozzz committed
34 35
  <a href="https://automate.browserstack.com/public-build/VHUxYy9zYnZqWnkxTTcyNEpPRVdzY2VzN1VhY3hBQUIrYTk2NGFtMnMvTT0tLWxuMk1vVnBzeDJ4cFpFY1JEK2xjSUE9PQ==--cf445693d1fc03efd86a3a5030d079a0de3ece7a">
    <img src="https://automate.browserstack.com/badge.svg?badge_key=VHUxYy9zYnZqWnkxTTcyNEpPRVdzY2VzN1VhY3hBQUIrYTk2NGFtMnMvTT0tLWxuMk1vVnBzeDJ4cFpFY1JEK2xjSUE9PQ==--cf445693d1fc03efd86a3a5030d079a0de3ece7a"/>
36
  </a>
37 38 39 40

  <a href="https://weblate.framasoft.org/projects/peertube/angular/">
    <img src="https://weblate.framasoft.org/widgets/peertube/-/angular/svg-badge.svg"/>
  </a>
Chocobozzz's avatar
Chocobozzz committed
41 42 43 44 45 46 47
</p>

<p align="center">
  <strong>Server</strong>

  <br />

48 49
  <a href="https://github.com/Chocobozzz/PeerTube/actions?query=workflow%3A%22Test+Suite%22+branch%3Adevelop">
    <img alt="test suite status" src="https://github.com/Chocobozzz/PeerTube/workflows/Test%20Suite/badge.svg" />
Chocobozzz's avatar
Chocobozzz committed
50 51
  </a>

Chocobozzz's avatar
Chocobozzz committed
52
  <a href="https://standardjs.com/">
Chocobozzz's avatar
Chocobozzz committed
53
    <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
Chocobozzz's avatar
Chocobozzz committed
54 55
  </a>
</p>
56

Chocobozzz's avatar
Chocobozzz committed
57 58 59
<br />

<p align="center">
60
  <a href="https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3">
Chocobozzz's avatar
Chocobozzz committed
61
    <img src="https://lutim.cpy.re/9CLXh0Ys.png" alt="screenshot" />
Chocobozzz's avatar
Chocobozzz committed
62 63
  </a>
</p>
64

Thomas Kuntz's avatar
Thomas Kuntz committed
65 66 67
Introduction
----------------------------------------------------------------

Chocobozzz's avatar
Chocobozzz committed
68 69 70 71 72 73
PeerTube is a free, decentralized and federated video platform developed as an alternative to other platforms that centralize our data and attention, such as YouTube, Dailymotion or Vimeo. :clapper:

But one organization hosting PeerTube alone may not have enough money to pay for bandwidth and video storage of its servers,
all servers of PeerTube are interoperable as a federated network, and non-PeerTube servers can be part of the larger Vidiverse
(federated video network) by talking our implementation of ActivityPub.
Video load is reduced thanks to P2P in the web browser using <a href="https://github.com/webtorrent/webtorrent">WebTorrent</a> or <a href="https://github.com/novage/p2p-media-loader">p2p-media-loader</a>.
Thomas Kuntz's avatar
Thomas Kuntz committed
74 75

To learn more, see:
76 77
* This [two-minute video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) (hosted on PeerTube) explaining what PeerTube is and how it works
* PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org)
Thomas Kuntz's avatar
Thomas Kuntz committed
78 79 80 81
* Demonstration instances:
  * [peertube.cpy.re](https://peertube.cpy.re)
  * [peertube2.cpy.re](https://peertube2.cpy.re)
  * [peertube3.cpy.re](https://peertube3.cpy.re)
82
* This [video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) demonstrating the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) (a decentralized Twitter alternative)
Thomas Kuntz's avatar
Thomas Kuntz committed
83

Rigel Kent's avatar
Rigel Kent committed
84
:sparkles: Features
Rigel Kent's avatar
Rigel Kent committed
85
----------------------------------------------------------------
86

Rigel Kent's avatar
Rigel Kent committed
87
<img src="https://lutim.cpy.re/AHbctLjn.png" align="left" height="300px"/>
88
<h3 align="left">Video streaming, even in live!</h3>
Rigel Kent's avatar
Rigel Kent committed
89 90 91
<p align="left">
Just upload your videos, and be sure they will stream anywhere. Add a description, some tags and your video will be discoverable by the entire video fediverse, not just your instance. You can even embed a player on your favorite website!
</p>
92 93 94
<p align="left">
You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams!
</p>
Rigel Kent's avatar
Rigel Kent committed
95 96 97 98 99 100 101

---

<img src="https://lutim.cpy.re/cxWccUK7.png" align="right" height="200px"/>

<h3 align="right">Keep in touch with video creators</h3>
<p align="right">
102
Follow your favorite channels from PeerTube or really any other place. No need to have an account on the instance you watched a video to follow its author, you can do all of that from the Fediverse (Mastodon, Pleroma, and plenty others), or just with good ol' RSS.
Rigel Kent's avatar
Rigel Kent committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
</p>

---

<img src="https://lutim.cpy.re/K07EhFbt.png" align="left" height="200px"/>

<h3 align="left">An interface to call home</h3>
<p align="left">
Be it as a user or an instance administrator, you can decide what your experience will be like. Don't like the colors? They are easy to change. Don't want to list videos of an instance but let your users subscribe to them? Don't like the regular web client? All of that can be changed, and much more. No UX dark pattern, no mining your data, no video recommendation bullshit™.
</p>

---

<h3 align="right">Communities that help each other</h3>
<p align="right">
Chocobozzz's avatar
Chocobozzz committed
118
In addition to visitors using WebTorrent to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our <a href="https://docs.joinpeertube.org/contribute-architecture?id=redundancy-between-instances">redundancy guide</a>).
Rigel Kent's avatar
Rigel Kent committed
119 120
</p>
<p align="right">
Chocobozzz's avatar
Chocobozzz committed
121
Content creators can get help from their viewers in the simplest way possible: a support button showing a message linking to their donation accounts or really anything else. No more pay-per-view and advertisements that hurt visitors and <strike>incentivize</strike> alter creativity (more about that in our <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md">FAQ</a>).
Rigel Kent's avatar
Rigel Kent committed
122 123
</p>

124 125 126
:raised_hands: Contributing
----------------------------------------------------------------

127
You don't need to be a programmer to help!
128 129

You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing
Chocobozzz's avatar
Chocobozzz committed
130
guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink:
131 132 133 134 135

You can also join the cheerful bunch that makes our community:

* Chat<a name="contact"></a>:
  * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)**
Thomas Citharel's avatar
Thomas Citharel committed
136
  * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
137 138
* Forum:
  * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
Chocobozzz's avatar
Chocobozzz committed
139

140 141
Feel free to reach out if you have any questions or ideas! :speech_balloon:

Rigel Kent's avatar
Rigel Kent committed
142 143 144
:package: Create your own instance
----------------------------------------------------------------

Chocobozzz's avatar
Chocobozzz committed
145
See the [production guide](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md), which is the recommended way to install or upgrade PeerTube. For hardware requirements, see [Should I have a big server to run PeerTube?](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube) in the FAQ.
146

Chocobozzz's avatar
Chocobozzz committed
147
See the [community packages](https://docs.joinpeertube.org/install-unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md)).
148

Rigel Kent's avatar
Rigel Kent committed
149 150
:book: Documentation
----------------------------------------------------------------
Chocobozzz's avatar
Chocobozzz committed
151

Chocobozzz's avatar
Chocobozzz committed
152
If you have a question, please try to find the answer in the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md) first.
Rigel Kent's avatar
Rigel Kent committed
153 154

### User documentation
Chocobozzz's avatar
Chocobozzz committed
155

Chocobozzz's avatar
Chocobozzz committed
156
See the [user documentation](https://docs.joinpeertube.org/use-setup-account).
Chocobozzz's avatar
Chocobozzz committed
157

Rigel Kent's avatar
Rigel Kent committed
158
### Admin documentation
Chocobozzz's avatar
Chocobozzz committed
159

Chocobozzz's avatar
Chocobozzz committed
160
See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance).
Chocobozzz's avatar
Chocobozzz committed
161

Chocobozzz's avatar
Chocobozzz committed
162
See the more general [admin documentation](https://docs.joinpeertube.org/admin-following-instances).
Chocobozzz's avatar
Chocobozzz committed
163

Chocobozzz's avatar
Chocobozzz committed
164
### Tools documentation
165

Chocobozzz's avatar
Chocobozzz committed
166
Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain-tools).
167

Rigel Kent's avatar
Rigel Kent committed
168
### Technical documentation
Chocobozzz's avatar
Chocobozzz committed
169

Chocobozzz's avatar
Chocobozzz committed
170
See the [architecture blueprint](https://docs.joinpeertube.org/contribute-architecture) for a more detailed explanation of the architectural choices.
Chocobozzz's avatar
Spawn  
Chocobozzz committed
171

172
See our REST API documentation:
Arman's avatar
Arman committed
173
  * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml)
Lukas Winkler's avatar
Lukas Winkler committed
174
  * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
175

Chocobozzz's avatar
Chocobozzz committed
176
See our [ActivityPub documentation](https://docs.joinpeertube.org/api-activitypub).
Rigel Kent's avatar
Rigel Kent committed
177

178 179
## License

Chocobozzz's avatar
Chocobozzz committed
180
Copyright (C) 2015-2021 PeerTube Contributors (see [CREDITS.md](CREDITS.md))
181 182 183

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
Chocobozzz's avatar
Chocobozzz committed
184
by the Free Software Foundation, either version 3 of the License, or
185
(at your option) any later version.
186 187 188 189 190 191 192

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
Chocobozzz's avatar
Chocobozzz committed
193
along with this program.  If not, see <https://www.gnu.org/licenses/>.