X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=0802662cb0fc28bd5a9e85cd6a26cc3c01be56bb;hb=a797728009eb5c26cf55624a4a01e8ecb73f1297;hp=202d6680de52f714445628c51d48f5cb3fb3e0bb;hpb=e8395f027b6c3e3f757c740e35b20e76c51b03bd;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 202d6680d..0802662cb 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,8 @@ BitTorrent) inside the web browser, as of today. - [X] Video privacy settings (public, unlisted or private) - [X] Signaling a video to the admin origin PeerTube instance - [X] Federated videos comments +- [X] Update video thumbnails +- [X] Support video uploader button - [ ] Video imports (URL, Torrent, YouTube...) - [ ] Advanced search - [ ] Subtitles @@ -137,37 +139,21 @@ BitTorrent) inside the web browser, as of today. * **NodeJS >= 8.x** * yarn * OpenSSL (cli) - * FFmpeg + * **FFmpeg >= 3.x** ## Run using Docker -You can quickly get a server running using Docker. You need to have [docker](https://www.docker.com/community-edition) and [docker-compose](https://docs.docker.com/compose/install/) installed. - -For this example configuration, you should also run a reverse proxy. The example -Docker Compose file provides example labels for the Traefik load balancer, -though any HTTP reverse proxy is compatible. - -Example for running a peertube server locally: - -```bash -sudo \ - PEERTUBE_HOSTNAME=peertube.lvh.me \ - PEERTUBE_ADMIN_EMAIL=test@example.com \ - PEERTUBE_TRANSCODING_ENABLED=true \ - docker-compose up app -``` - -(Get the initial root user password from the program output.) +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](/.github/CONTRIBUTING.md) -to see how to contribute to PeerTube. Spoiler alert: you don't need to be a +to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a coder to help! ## API REST documentation @@ -177,6 +163,15 @@ For now only on Github: * 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) +## 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](/ARCHITECTURE.md) for a more detailed explanation.