README.md 9.65 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
<p align=center>
  <strong><a href="https://joinpeertube.org">Website</a></strong>
Chocobozzz's avatar
Chocobozzz committed
9
  | <strong><a href="https://joinpeertube.org/instances">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/ZEZqamJQUXFQd1l3cFp3QmxLSVVwdjBGZjNGc3J2M09INFpka296em9VYz0tLUowWVdoemxkY1hBOU9aZzNlY1htZ3c9PQ==--68e0184ce76481d36559d681d9cddc68235ff536">
    <img src="https://automate.browserstack.com/badge.svg?badge_key=ZEZqamJQUXFQd1l3cFp3QmxLSVVwdjBGZjNGc3J2M09INFpka296em9VYz0tLUowWVdoemxkY1hBOU9aZzNlY1htZ3c9PQ==--68e0184ce76481d36559d681d9cddc68235ff536"/>
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
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:

Chocobozzz's avatar
Chocobozzz committed
70
To learn more:
71
72
* 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
73
* Demonstration instances:
Chocobozzz's avatar
Chocobozzz committed
74
75
76
  * [peertube.cpy.re](https://peertube.cpy.re) (stable)
  * [peertube2.cpy.re](https://peertube2.cpy.re) (Nightly)
  * [peertube3.cpy.re](https://peertube3.cpy.re) (RC)
77
* 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
78

Rigel Kent's avatar
Rigel Kent committed
79
:sparkles: Features
Rigel Kent's avatar
Rigel Kent committed
80
----------------------------------------------------------------
81

Chocobozzz's avatar
Chocobozzz committed
82
83
84
85
86
87
<p align=center>
  <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-viewers">All features for viewers</a></strong>
  | <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-content-creators">All features for content creators</a></strong>
  | <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-administrators">All features for administrators</a></strong>
</p>

Rigel Kent's avatar
Rigel Kent committed
88
<img src="https://lutim.cpy.re/AHbctLjn.png" align="left" height="300px"/>
89
<h3 align="left">Video streaming, even in live!</h3>
Rigel Kent's avatar
Rigel Kent committed
90
91
92
<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>
93
94
95
<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
96
97
98
99
100
101
102

---

<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">
103
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
</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
119
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
120
121
</p>
<p align="right">
Chocobozzz's avatar
Chocobozzz committed
122
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
123
124
</p>

Chocobozzz's avatar
Chocobozzz committed
125
126


127
128
129
:raised_hands: Contributing
----------------------------------------------------------------

130
You don't need to be a programmer to help!
131
132

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
133
guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink:
134
135
136
137

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

* Chat<a name="contact"></a>:
Thomas Citharel's avatar
Thomas Citharel committed
138
  * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
139
  * IRC : **[#peertube on irc.libera.chat:6697](https://web.libera.chat/#peertube)**
140
141
* Forum:
  * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
Chocobozzz's avatar
Chocobozzz committed
142

143
144
Feel free to reach out if you have any questions or ideas! :speech_balloon:

Rigel Kent's avatar
Rigel Kent committed
145
146
147
:package: Create your own instance
----------------------------------------------------------------

148
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://joinpeertube.org/faq#should-i-have-a-big-server-to-run-peertube) in the FAQ.
149

Chocobozzz's avatar
Chocobozzz committed
150
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)).
151

Rigel Kent's avatar
Rigel Kent committed
152
153
:book: Documentation
----------------------------------------------------------------
Chocobozzz's avatar
Chocobozzz committed
154

155
If you have a question, please try to find the answer in the [FAQ](https://joinpeertube.org/faq) first.
Rigel Kent's avatar
Rigel Kent committed
156
157

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

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

Rigel Kent's avatar
Rigel Kent committed
161
### Admin documentation
Chocobozzz's avatar
Chocobozzz committed
162

Chocobozzz's avatar
Chocobozzz committed
163
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
164

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

Chocobozzz's avatar
Chocobozzz committed
167
### Tools documentation
168

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

Rigel Kent's avatar
Rigel Kent committed
171
### Technical documentation
Chocobozzz's avatar
Chocobozzz committed
172

Chocobozzz's avatar
Chocobozzz committed
173
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
174

175
See our REST API documentation:
Arman's avatar
Arman committed
176
  * 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
177
  * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
178

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

181
182
## License

Chocobozzz's avatar
Chocobozzz committed
183
Copyright (C) 2015-2021 PeerTube Contributors (see [CREDITS.md](CREDITS.md))
184
185
186

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
187
by the Free Software Foundation, either version 3 of the License, or
188
(at your option) any later version.
189
190
191
192
193
194
195

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
196
along with this program.  If not, see <https://www.gnu.org/licenses/>.