X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=95f274b7b652effd43d7d49f6cc148f89a9ea0c3;hb=276d03ed1a469fd4e3579f92392b6f9a1567d1ca;hp=202d6680de52f714445628c51d48f5cb3fb3e0bb;hpb=e8395f027b6c3e3f757c740e35b20e76c51b03bd;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 202d6680d..95f274b7b 100644 --- a/README.md +++ b/README.md @@ -141,33 +141,17 @@ BitTorrent) inside the web browser, as of today. ## 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 +161,10 @@ 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/import-videos.md) + ## Architecture See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.