X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=8f3de1c97c1f62fcf7e5c3094db2033d0e80177c;hb=9258e9a4a37911fc64b5faada2a7e604bd1ede1f;hp=1047ea6e9bdc59938b9bcf8b505fb3f95c8570f3;hpb=13fc89f4a4b91b3da10493517de556240fb65463;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 1047ea6e9..8f3de1c97 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,42 @@
+ Website + | Join an instance + | Create an instance + | Chat with us + | Donate +
+ ++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. +
+ ++ Developed with ❤ by Framasoft +
+ ++ + + +
@@ -25,226 +45,158 @@ Prototype of a decentralized video streaming platform using P2P (BitTorrent) dir+ All features for viewers + | All features for content creators + | All features for administrators +
-The administrator password is automatically generated and can be found in the logs. You can set another password with: + ++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! +
++You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams! +
- $ NODE_ENV=production npm run reset-password -- -u root +--- -**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx + -**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd ++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. +
-You can check the application (CORS headers, tracker websocket...) by running: +--- - $ NODE_ENV=production npm run check + -### Upgrade ++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â¢. +
-The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application: +--- - # systemctl stop peertube - $ npm run upgrade - # systemctl start peertube ++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 redundancy guide). +
++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 alter creativity (more about that in our FAQ). +
-### Development -In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds and the client files are automatically compiled when we modify them: - $ npm run dev +:raised_hands: Contributing +---------------------------------------------------------------- -The administrator password is displayed in the command output and can be found in the logs. +You don't need to be a programmer to help! -### Test with 3 fresh nodes +You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing +guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink: - $ npm run clean:server:test - $ npm run play +You can also join the cheerful bunch that makes our community: -Then you will can access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. If you call "make friends" on `http://localhost:9002`, the pod 2 and 3 will become friends. Then if you call "make friends" on `http://localhost:9001` it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :) +* Chat: + * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)** + * IRC : **[#peertube on irc.libera.chat:6697](https://web.libera.chat/#peertube)** +* Forum: + * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube) -### Other commands +Feel free to reach out if you have any questions or ideas! :speech_balloon: -To print all available command run: +:package: Create your own instance +---------------------------------------------------------------- - $ npm run help +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. -## Dockerfile +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)). -You can test it inside Docker with the [PeerTube-Docker repository](https://github.com/Chocobozzz/PeerTube-Docker). Moreover it can help you to check how to create an environment with the required dependencies for PeerTube on a GNU/Linux distribution. +:book: Documentation +---------------------------------------------------------------- -## Contributing +If you have a question, please try to find the answer in the [FAQ](https://joinpeertube.org/faq) first. -See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md). +### User documentation -See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md). +See the [user documentation](https://docs.joinpeertube.org/use/setup-account). -See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md). +### Admin documentation +See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance). -## Architecture +See the more general [admin documentation](https://docs.joinpeertube.org/admin/following-instances). -See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication. +### Tools documentation -### Backend +Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain/tools). - * The backend is a REST API - * Servers communicate with each others through it - * A network is composed by servers that communicate between them - * Each server of a network has a list of all other servers of this network - * When a new installed server wants to join a network, it just has to get the servers list through a server that is already in the network and tell "Hi I'm new in the network, communicate with me and share me your servers list please". Then the server will "make friend" with each server of this list - * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...) - * If a user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network - * Each server has a RSA key to encrypt and sign communications with other servers - * A server is a tracker responsible for all the videos uploaded in it - * Even if nobody watches a video, it is seeded by the server (throught [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded - * A network can live and evolve by expelling bad pod (with too many downtimes for example) +### Technical documentation -See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :) +See the [architecture blueprint](https://docs.joinpeertube.org/contribute/architecture) for a more detailed explanation of the architectural choices. -Here are some simple schemes: +See our REST API documentation: + * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml) + * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api/rest-reference.html) -+See our [ActivityPub documentation](https://docs.joinpeertube.org/api/activitypub). - +## License - +### Logo - +[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), by [Framasoft](https://framasoft.org) - +### Code - +Copyright (C) 2015-2023 PeerTube Contributors (see [CREDITS.md](/CREDITS.md)) -
+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 +by the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. -### Frontend +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. -There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...). -The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI. +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see