directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
</h4>
-**PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit
-that promotes, spreads and develops free culture in general, and free-libre
-software in particular. If you want to support this project, please [consider
-donating them](https://soutenir.framasoft.org/en/).**
+**PeerTube is developed by [Framasoft](https://framasoft.org/?l=en), a non-profit
+that promotes and spreads free culture in general, and free-libre software in
+particular. If you want to support this project, please [consider
+donating to them](https://soutenir.framasoft.org/en/).**
<p align="center">
<strong>Client</strong>
<img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
</a>
- <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev">
+ <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client&type=dev">
<img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
</a>
</p>
<img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
</a>
- <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
+ <a href="https://david-dm.org/Chocobozzz/PeerTube?type=dev">
<img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
</a>
</a>
</p>
+<p align="center">
+ <strong><a title="Website" target="_blank" href="https://joinpeertube.org">Website</a> |
+ <a title="Instances list" target="_blank" href="https://instances.joinpeertube.org">Instances list</a>
+ </strong>
+</p>
+
## Demonstration
Want to see it in action?
* Demonstration servers:
- * [peertube.cpy.re](http://peertube.cpy.re)
- * [peertube2.cpy.re](http://peertube2.cpy.re)
+ * [peertube.cpy.re](http://peertube.cpy.re)
+ * [peertube2.cpy.re](http://peertube2.cpy.re)
* [peertube3.cpy.re](http://peertube3.cpy.re)
* [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
- to see how the "decentralization feature" looks like
+ to see what the "decentralization feature" looks like
+ * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) to see
+ the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon)
## Why
[WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus
BitTorrent) inside the web browser, as of today.
-## Features
-
-- [X] Angular frontend
-- [X] Join the fediverse
- - [X] Follow other instances
- - [X] Unfollow an instance
- - [X] Get for the followers/following list
-- [X] Upload a video
- - [X] Seed the video
- - [X] Send the meta data with ActivityPub to followers
-- [X] Remove the video
-- [X] List the videos
-- [X] View the video in an HTML5 player with WebTorrent
-- [X] Admin panel
-- [X] OpenGraph tags
-- [X] OEmbed
-- [X] Update video
-- [X] Federated videos view counter
-- [X] Federated videos likes/dislikes
-- [X] Transcoding to different definitions
-- [X] Download file/torrent
-- [X] User video bytes quota
-- [X] User video channels
-- [X] NSFW warnings/settings
-- [X] Video description in markdown
-- [X] User roles (administrator, moderator)
-- [X] User registration
-- [X] Video privacy settings (public, unlisted or private)
-- [X] Signaling a video to the admin origin PeerTube instance
-- [X] Federated videos comments
-- [ ] Video imports (URL, Torrent, YouTube...)
-- [ ] Advanced search
-- [ ] Subtitles
-- [ ] User playlist
-- [ ] User subscriptions (by tags, author...)
-- [ ] Add "DDOS" security
-
-
-## Front compatibility
-
- * Firefox
- * Chrome/Chromium
-
## Dependencies
* nginx
* PostgreSQL
+ * Redis
* **NodeJS >= 8.x**
* yarn
* OpenSSL (cli)
- * FFmpeg
+ * **FFmpeg >= 3.x**
+
+## Run using Docker
+
+See the [docker guide](/support/doc/docker.md)
## Production
-See the [production guide](support/doc/production.md).
+See the [production guide](/support/doc/production.md).
-## Contributing
+## Contributing/Test
See the [contributing
-guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md)
-to see how to contribute to PeerTube. Spoiler alert: you don't need to be a
+guide](/.github/CONTRIBUTING.md)
+to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a
coder to help!
+## API REST documentation
+
+Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md)
+
+Endpoints documentation:
+
+ * HTML version: [/support/doc/api/html/index.html](https://htmlpreview.github.io/?https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/html/index.html)
+ * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
+
+## Tools
+
+ * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
+ * [Upload videos from the CLI](/support/doc/tools.md)
+
+## FAQ
+
+If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first.
+
## Architecture
-See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explanation.
+See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
### Backend
<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
</p>
+
+## License
+
+Copyright (C) 2018 PeerTube Contributors
+
+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.
+
+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
+along with this program. If not, see <http://www.gnu.org/licenses/>.
projects / oweals / peertube.git / blobdiff