**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/).**
+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>
Want to see it in action?
- * [Demo server](http://peertube.cpy.re)
+ * Demonstration servers:
+ * [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
- * Experimental demo servers that share videos (they are in the same
- network): [peertube2](http://peertube2.cpy.re),
- [peertube3](http://peertube3.cpy.re). Since I do experiments with them,
- sometimes they might not work correctly.
+ to see what the "decentralization feature" looks like
+
+*Currently PeerTube is still in alpha (we plan to release a beta in march). Demonstration servers do not support public registration. If you really want to test PeerTube before the public release, here is a list of PeerTube servers: https://github.com/Chocobozzz/PeerTube/wiki#other-peertube-servers.*
## Why
enough because one video could become famous and overload the server. It's the
reason why we need to use a P2P protocol to limit the server load. Thanks to
[WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus
-bittorrent) inside the web browser, as of today.
+BitTorrent) inside the web browser, as of today.
## Features
-- [X] Frontend
- - [X] Angular frontend
+- [X] Angular frontend
- [X] Join the fediverse
- [X] Follow other instances
- [X] Unfollow an instance
- [X] OpenGraph tags
- [X] OEmbed
- [X] Update video
-- [X] Videos view counter
-- [X] Videos likes/dislikes
+- [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 registration
- [X] Video privacy settings (public, unlisted or private)
- [X] Signaling a video to the admin origin PeerTube instance
-- [ ] Videos comments
+- [X] Federated videos comments
+- [X] Update video thumbnails
+- [X] Support video uploader button
+- [ ] Video imports (URL, Torrent, YouTube...)
+- [ ] Advanced search
+- [ ] Subtitles
- [ ] User playlist
- [ ] User subscriptions (by tags, author...)
- [ ] Add "DDOS" security
-## Installation
-
-See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete
-installation commands.
+## Front compatibility
-### Front compatibility
+ * Firefox
+ * Chrome/Chromium
- * Chromium
- * Firefox (>= 42 for MediaSource support)
-
-### Dependencies
+## Dependencies
+ * nginx
+ * PostgreSQL
+ * Redis
* **NodeJS >= 8.x**
* yarn
* OpenSSL (cli)
- * PostgreSQL
* FFmpeg
-#### Debian
-
- 1. Install NodeJS 8.x (current LTS):
- [https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
- 2. Install yarn:
- [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
- 4. Run:
-
-```bash
- $ apt-get update
- $ apt-get install ffmpeg postgresql openssl
-```
-
-#### Ubuntu 16.04
-
- 1. Install NodeJS 8.x (current LTS): (same as Debian)
- 2. Install yarn: (same as Debian)
- 3. Run:
-
-```bash
- $ apt-get update
- $ apt-get install ffmpeg postgresql openssl
-```
-
-#### Arch Linux
-
- 1. Run:
-
-```bash
- $ pacman -S nodejs yarn ffmpeg postgresql openssl
-```
-
-#### Other distributions
-
-Feel free to update this README file in a pull request!
-
-### Build from the sources
+## Run using Docker
-```bash
- $ git clone -b master https://github.com/Chocobozzz/PeerTube
- $ cd PeerTube
- $ yarn install
- $ npm run build
-```
+See the [docker guide](/support/doc/docker.md)
-## Usage
+## Production
-### Production
+See the [production guide](/support/doc/production.md).
-If you want to run PeerTube in production (which might be a bad idea for now :) ):
+## Contributing/Test
-```bash
- $ cp config/production.yaml.example config/production.yaml
-```
-
-Then edit the `config/production.yaml` file according to your webserver
-configuration. Keys set in this file will override those of
-`config/default.yml`.
-
-Finally, run the server with the `NODE_ENV` environment variable set to
-`production`:
-
-```bash
- $ NODE_ENV=production npm start
-```
-
-The administrator password is automatically generated and can be found in the
-logs. You can set another password with:
-
-```bash
- $ NODE_ENV=production npm run reset-password -- -u root
-```
-
-**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx <br />
-**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
-
-You can check the application (CORS headers, tracker websocket...) by running:
-
-```bash
- $ NODE_ENV=production npm run check
-```
-
-### Upgrade
-
-The following commands will upgrade the source (according to your current
-branch), upgrade node modules and rebuild client application:
-
-```bash
- # systemctl stop peertube
- $ npm run upgrade-peertube
- # systemctl start peertube
-```
-
-### Test with three fresh nodes
+See the [contributing
+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!
-```bash
- $ npm run clean:server:test
- $ npm run play
-```
+## API REST documentation
-Then you will get 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.
+For now only on Github:
-### Other commands
+ * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html)
+ * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
-To print all available commands, run:
+## Tools
-```bash
- $ npm run help
-```
+ * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
+ * [Upload videos from the CLI](/support/doc/tools.md)
-## Contributing
+## FAQ
-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
-coder to help!
+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
projects / github / Chocobozzz / PeerTube.git / blobdiff