]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - README.md
Translated using Weblate (Galician)
[github/Chocobozzz/PeerTube.git] / README.md
CommitLineData
d3b52378 1<h1 align="center">
40256645 2 <a href="https://joinpeertube.org">
c4ac4593
TK
3 <img src="https://joinpeertube.org/img/brand.png" alt="PeerTube">
4 </a>
d3b52378 5</h1>
8c308c2b 6
40256645
RK
7<p align=center>
8 <strong><a href="https://joinpeertube.org">Website</a></strong>
9 | <strong><a href="https://instances.joinpeertube.org">Join an instance</a></strong>
8af9b8ae 10 | <strong><a href="#package-create-your-own-instance">Create an instance</a></strong>
40256645 11 | <strong><a href="#contact">Chat with us</a></strong>
3f82804c 12 | <strong><a href="https://framasoft.org/en/#soutenir">Donate</a></strong>
40256645
RK
13</p>
14
f2de393e 15<p align="center">
3f82804c 16Be 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.
f2de393e 17</p>
88c8d458 18
34515397
C
19<p align="center">
20 <strong>Developed with &#10084; by <a href="https://framasoft.org">Framasoft</a></strong>
21</p>
22
23<p align="center">
24 <a href="https://framasoft.org">
1eb23e12 25 <img width="150px" src="https://lutim.cpy.re/FeRgHH8r.png" alt="Framasoft logo"/>
34515397
C
26 </a>
27</p>
28
d3b52378
C
29<p align="center">
30 <strong>Client</strong>
191ce958 31
d3b52378 32 <br />
8c308c2b 33
ee663cce
C
34 <a href="https://automate.browserstack.com/public-build/VHUxYy9zYnZqWnkxTTcyNEpPRVdzY2VzN1VhY3hBQUIrYTk2NGFtMnMvTT0tLWxuMk1vVnBzeDJ4cFpFY1JEK2xjSUE9PQ==--cf445693d1fc03efd86a3a5030d079a0de3ece7a">
35 <img src="https://automate.browserstack.com/badge.svg?badge_key=VHUxYy9zYnZqWnkxTTcyNEpPRVdzY2VzN1VhY3hBQUIrYTk2NGFtMnMvTT0tLWxuMk1vVnBzeDJ4cFpFY1JEK2xjSUE9PQ==--cf445693d1fc03efd86a3a5030d079a0de3ece7a"/>
2e8e97f3 36 </a>
5f59cf07
RK
37
38 <a href="https://weblate.framasoft.org/projects/peertube/angular/">
39 <img src="https://weblate.framasoft.org/widgets/peertube/-/angular/svg-badge.svg"/>
40 </a>
d3b52378
C
41</p>
42
43<p align="center">
44 <strong>Server</strong>
45
46 <br />
47
7dba27a8
RK
48 <a href="https://github.com/Chocobozzz/PeerTube/actions?query=workflow%3A%22Test+Suite%22+branch%3Adevelop">
49 <img alt="test suite status" src="https://github.com/Chocobozzz/PeerTube/workflows/Test%20Suite/badge.svg" />
d3b52378
C
50 </a>
51
c15aff66 52 <a href="https://standardjs.com/">
d31910dd 53 <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
d3b52378
C
54 </a>
55</p>
b4c5a1f8 56
d31910dd
C
57<br />
58
59<p align="center">
669121a6 60 <a href="https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3">
c15aff66 61 <img src="https://lutim.cpy.re/9CLXh0Ys.png" alt="screenshot" />
d31910dd
C
62 </a>
63</p>
15e3cdaa 64
9644c2a8
TK
65Introduction
66----------------------------------------------------------------
67
fbb740a3
C
68PeerTube 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:
69
70But one organization hosting PeerTube alone may not have enough money to pay for bandwidth and video storage of its servers,
71all servers of PeerTube are interoperable as a federated network, and non-PeerTube servers can be part of the larger Vidiverse
72(federated video network) by talking our implementation of ActivityPub.
73Video 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>.
9644c2a8
TK
74
75To learn more, see:
f95cb03a
RK
76* 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
77* PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org)
9644c2a8
TK
78* Demonstration instances:
79 * [peertube.cpy.re](https://peertube.cpy.re)
80 * [peertube2.cpy.re](https://peertube2.cpy.re)
81 * [peertube3.cpy.re](https://peertube3.cpy.re)
f95cb03a 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)
9644c2a8 83
43971993 84:sparkles: Features
40256645 85----------------------------------------------------------------
15e3cdaa 86
43971993 87<img src="https://lutim.cpy.re/AHbctLjn.png" align="left" height="300px"/>
92c871b4 88<h3 align="left">Video streaming, even in live!</h3>
43971993
RK
89<p align="left">
90Just 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!
91</p>
92c871b4
RK
92<p align="left">
93You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams!
94</p>
43971993
RK
95
96---
97
98<img src="https://lutim.cpy.re/cxWccUK7.png" align="right" height="200px"/>
99
100<h3 align="right">Keep in touch with video creators</h3>
101<p align="right">
2f050a99 102Follow 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.
43971993
RK
103</p>
104
105---
106
107<img src="https://lutim.cpy.re/K07EhFbt.png" align="left" height="200px"/>
108
109<h3 align="left">An interface to call home</h3>
110<p align="left">
111Be 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â„¢.
112</p>
113
114---
115
116<h3 align="right">Communities that help each other</h3>
117<p align="right">
7cf88d09 118In 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>).
43971993
RK
119</p>
120<p align="right">
53a6d0a3 121Content 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>).
43971993
RK
122</p>
123
0c4706b2
TK
124:raised_hands: Contributing
125----------------------------------------------------------------
126
92c871b4 127You don't need to be a programmer to help!
0c4706b2
TK
128
129You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing
53a6d0a3 130guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink:
0c4706b2
TK
131
132You can also join the cheerful bunch that makes our community:
133
134* Chat<a name="contact"></a>:
135 * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)**
8dae69db 136 * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
0c4706b2
TK
137* Forum:
138 * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
853c3d53 139
0c4706b2
TK
140Feel free to reach out if you have any questions or ideas! :speech_balloon:
141
40256645
RK
142:package: Create your own instance
143----------------------------------------------------------------
144
53a6d0a3 145See 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.
e8395f02 146
7cf88d09 147See 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)).
e8395f02 148
40256645
RK
149:book: Documentation
150----------------------------------------------------------------
6dde6a31 151
53a6d0a3 152If you have a question, please try to find the answer in the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md) first.
40256645
RK
153
154### User documentation
6dde6a31 155
7cf88d09 156See the [user documentation](https://docs.joinpeertube.org/use-setup-account).
d59a8da8 157
40256645 158### Admin documentation
c0c7416a 159
4053ba6f 160See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance).
d59a8da8 161
7cf88d09 162See the more general [admin documentation](https://docs.joinpeertube.org/admin-following-instances).
d59a8da8 163
e2ffb59e 164### Tools documentation
35501c0f 165
7cf88d09 166Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain-tools).
35501c0f 167
40256645 168### Technical documentation
28e014c0 169
7cf88d09 170See the [architecture blueprint](https://docs.joinpeertube.org/contribute-architecture) for a more detailed explanation of the architectural choices.
8c308c2b 171
3f82804c 172See our REST API documentation:
7d48ea83 173 * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml)
24339368 174 * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
5a649344 175
7cf88d09 176See our [ActivityPub documentation](https://docs.joinpeertube.org/api-activitypub).
40256645 177
5a649344
T
178## License
179
9bb720f3 180Copyright (C) 2015-2021 PeerTube Contributors (see [CREDITS.md](CREDITS.md))
5a649344
T
181
182This program is free software: you can redistribute it and/or modify
183it under the terms of the GNU Affero General Public License as published
853c3d53 184by the Free Software Foundation, either version 3 of the License, or
97b72ed1 185(at your option) any later version.
5a649344
T
186
187This program is distributed in the hope that it will be useful,
188but WITHOUT ANY WARRANTY; without even the implied warranty of
189MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
190GNU Affero General Public License for more details.
191
192You should have received a copy of the GNU Affero General Public License
c15aff66 193along with this program. If not, see <https://www.gnu.org/licenses/>.