1 # Welcome to the contributing guide for PeerTube
3 Interested in contributing? Awesome!
5 **This guide will present you the following contribution topics:**
7 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
8 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
10 - [Translate](#translate)
11 - [Give your feedback](#give-your-feedback)
12 - [Write documentation](#write-documentation)
13 - [Improve the website](#improve-the-website)
15 - [Prerequisites](#prerequisites)
16 - [Online development](#online-development)
17 - [Server side](#server-side)
18 - [Client side](#client-side)
19 - [Client and server side](#client-and-server-side)
21 - [RTL layout](#rtl-layout)
23 - [Unit/integration tests](#unitintegration-tests)
24 - [Play with a federation of PeerTube servers](#play-with-a-federation-of-peertube-servers)
26 - [OpenAPI documentation](#openapi-documentation)
27 - [Environment variables](#environment-variables)
28 - [Generate/pull translations](#generatepull-translations)
29 - [Release PeerTube](#release-peertube)
30 - [PeerTube packages](#peertube-packages)
32 - [Monitoring](#monitoring)
33 - [Test live stream](#test-live-stream)
34 - [Plugins & Themes](#plugins--themes)
36 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
40 You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
45 You don't need to know how to code to start contributing to PeerTube! Other
46 contributions are very valuable too, among which: you can test the software and
47 report bugs, you can give feedback on potential bugs, features that you are
48 interested in, user interface, design, decentralized architecture...
51 ## Write documentation
53 You can help to write the documentation of the REST API, code, architecture,
56 For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory.
57 Then, you can just open the `openapi.yaml` file in a special editor like [http://editor.swagger.io/](http://editor.swagger.io/) to easily see and edit the documentation. You can also use [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) and run `redoc-cli serve --watch support/doc/api/openapi.yaml` to see the final result.
60 * Routes are defined in [/server/controllers/](https://github.com/Chocobozzz/PeerTube/tree/develop/server/controllers) directory
61 * Parameters validators are defined in [/server/middlewares/validators](https://github.com/Chocobozzz/PeerTube/tree/develop/server/middlewares/validators) directory
62 * Models sent/received by the controllers are defined in [/shared/models](https://github.com/Chocobozzz/PeerTube/tree/develop/shared/models) directory
65 ## Improve the website
67 PeerTube's website is [joinpeertube.org](https://joinpeertube.org), where people can learn about the project and how it works – note that it is not a PeerTube instance, but rather the project's homepage.
69 You can help us improve it too!
71 It is not hosted on GitHub but on [Framasoft](https://framasoft.org/)'s own [GitLab](https://about.gitlab.com/) instance, [FramaGit](https://framagit.org): https://framagit.org/framasoft/peertube/joinpeertube
76 Always talk about features you want to develop by creating/finding and commenting the issue tackling your problem
77 before you start working on it, and inform the community that you begin coding by claiming the issue.
79 Once you are ready to show your code to ask for feedback, submit a *draft* Pull Request.
80 Once you are ready for a code review before merge, submit a Pull Request. In any case, please
81 link your PR to the issues it solves by using the GitHub syntax: "fixes #issue_number".
85 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
87 1) Make sure that you have followed
88 [the steps](/support/doc/dependencies.md)
89 to install the dependencies.
90 1) Install [parallel](https://www.gnu.org/software/parallel/) to be able to run tests.
91 1) Fork the GitHub repository.
92 1) Run the following commands.
94 git clone https://github.com/Chocobozzz/PeerTube
96 git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
97 yarn install --pure-lockfile
100 Note that development is done on the `develop` branch. If you want to hack on
101 PeerTube, you should switch to that branch. Also note that you have to repeat
102 the `yarn install --pure-lockfile` command.
104 When you create a new branch you should also tell to use your repo for upload
105 not default one. To do just do:
107 git push --set-upstream me <your branch name>
110 Then, create a postgres database and user with the values set in the
111 `config/default.yaml` file. For instance, if you do not change the values
112 there, the following commands would create a new database called `peertube_dev`
113 and a postgres user called `peertube` with password `peertube`:
116 # sudo -u postgres createuser -P peertube
117 Enter password for new role: peertube
118 # sudo -u postgres createdb -O peertube peertube_dev
121 Then enable extensions PeerTube needs:
124 sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
125 sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
128 PeerTube also requires a running redis server, no special setup is needed for
131 In dev mode, administrator username is **root** and password is **test**.
133 ### Online development
135 You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
137 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
141 To develop on the server-side:
147 Then, the server will listen on `localhost:9000`. When server source files
148 change, these are automatically recompiled and the server will automatically
151 More detailed documentation is available:
152 * [Server code/architecture](https://docs.joinpeertube.org/contribute/architecture#server)
153 * [Server development (adding a new feature...)](/support/doc/development/server.md)
157 To develop on the client side:
163 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
164 Client files are automatically compiled on change, and the web browser will
165 reload them automatically thanks to hot module replacement.
167 More detailed documentation is available:
168 * [Client code/architecture](https://docs.joinpeertube.org/contribute/architecture#client)
171 ### Client and server side
173 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
174 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
175 and the web server is automatically restarted.
183 The embed is a standalone application built using Webpack.
184 The generated files (HTML entrypoint and multiple JS and CSS files) are served by the PeerTube server (behind `localhost:9000/videos/embed/:videoUUID` or `localhost:9000/video-playlists/embed/:playlistUUID`).
185 The following command will compile embed files and run the PeerTube server:
193 To test RTL (right-to-left) layout using `ar` locale:
196 npm run dev -- --ar-locale
201 #### Unit/integration tests
203 Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves
204 as expected and respect the syntax conventions. They will run upon PR submission as part of our CI, but running them beforehand yourself will get you faster feedback and save CI runner time for others.
206 See the [dedicated documentation](/support/doc/development/tests.md) to run tests locally.
208 #### Play with a federation of PeerTube servers
210 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
211 Then, we can create the databases (if they don't already exist):
214 sudo -u postgres createuser you_username --createdb --superuser
215 createdb -O peertube peertube_test{1,2,3}
218 Build the application and flush the old tests data:
222 npm run clean:server:test
228 NODE_APP_INSTANCE=1 NODE_ENV=test npm start
229 NODE_APP_INSTANCE=2 NODE_ENV=test npm start
230 NODE_APP_INSTANCE=3 NODE_ENV=test npm start
233 Then you will get access to the three nodes at `http://127.0.0.1:900{1,2,3}`
234 with the `root` as username and `test{1,2,3}` for the password.
236 Instance configurations are in `config/test-{1,2,3}.yaml`.
240 To test emails with PeerTube:
242 * Run [mailslurper](http://mailslurper.com/)
243 * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=dev node dist/server`
245 ### OpenAPI documentation
247 The [REST API documentation](https://docs.joinpeertube.org/api-rest-reference.html) is generated from `support/doc/api/openapi.yaml` file.
248 To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command:
251 npx @redocly/cli preview-docs ./support/doc/api/openapi.yaml
254 ### Environment variables
256 PeerTube can be configured using environment variables.
257 See the list on https://docs.joinpeertube.org/maintain/configuration#environment-variables
259 Additionally to these ones, we provide some environment for dev/test purpose:
261 * `PRODUCTION_CONSTANTS=true`: in `NODE_ENV=dev` or `NODE_ENV=test` PeerTube customizes some constants. To prevent this behaviour, you can set `PRODUCTION_CONSTANTS` env to
263 * `PEERTUBE_LOCAL_CONFIG`: directory to find the local configuration file (used by web admin)
264 * `NODE_DB_LOG=false`: disable SQL request logging
266 ### Generate/pull translations
268 See the [dedicated documentation](/support/doc/development/localization.md) to update PeerTube translations from Weblate or to support a new locale.
272 See the [dedicated documentation](/support/doc/development/release.md) to release a new version of PeerTube.
274 ### PeerTube packages
276 This repository also contains other packages/libraries than PeerTube (embed API, PeerTube types...).
277 You can see the list on the [dedicated documentation](/support/doc/development/lib.md).
281 PeerTube uses GitHub actions to run tests every time a commit is pushed or a PR is opened.
282 You can find more information about these tasks on the [dedicated documentation](/support/doc/development/ci.md).
286 You can check the content of the client bundle or benchmark the REST API.
287 To do so, see the [dedicated documentation](/support/doc/development/monitoring.md).
291 To easily test a live stream on PeerTube:
292 * Enable live support in web admin configuration
293 * Create a permanent live on the PeerTube instance
294 * Get the **RTMP URL** and the **Live stream key**
295 * Send the live stream to PeerTube using `ffmpeg` using a local video:
298 ffmpeg -stream_loop -1 -re -i any-video.mp4 -c copy -f flv rtmp://{RTMP URL}/live/{STREAM KEY}
303 See the dedicated documentation: https://docs.joinpeertube.org/contribute/plugins