aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md44
1 files changed, 12 insertions, 32 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index cbd628c25..b5d7ede72 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -2,13 +2,15 @@
2 2
3Interested in contributing? Awesome! 3Interested in contributing? Awesome!
4 4
5**Quick Links:** 5**This guide will present you the following contribution topics:**
6 6
7 * [Translate](#translate) 7 * [Translate](#translate)
8 * [Give your feedback](#give-your-feedback) 8 * [Give your feedback](#give-your-feedback)
9 * [Write documentation](#write-documentation) 9 * [Write documentation](#write-documentation)
10 * [Develop](#develop) 10 * [Develop](#develop)
11 * [Improve the website](#improve-the-website) 11 * [Improve the website](#improve-the-website)
12 * [Troubleshooting](#troubleshooting)
13 * [Tutorials](#tutorials)
12 14
13## Translate 15## Translate
14 16
@@ -131,37 +133,7 @@ and the web server is automatically restarted.
131$ npm run dev 133$ npm run dev
132``` 134```
133 135
134Depending on your OS, you may face the following error : 136### Testing the federation of PeerTube servers
135```
136$ [nodemon] Internal watch failed: ENOSPC: no space left on device, watch '/PeerTube/dist'
137```
138
139This is due to your system's limit on the number of files you can monitor for live-checking changes. For example, Ubuntu uses inotify and this limit is set to 8192. Then you need to change this limit :
140```
141echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
142```
143
144See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers
145
146### Configurations for VPS
147
148If you want to develop using a Virtual Private Server, you will need to configure the url for the API and the hostname. First, you need to edit the [client/src/environments/environment.hmr.ts](client/src/environments/environment.hmr.ts) file by replacing the `localhost` in the `apiUrl` field with the address of your VPS. Thus, the [Hot Module Replacement](https://webpack.js.org/concepts/hot-module-replacement/) from Webpack will be set up for developping with live-reload.
149
150Next, you will need to edit the [config/default.yaml](config/default.yaml) file. Just replace the `localhost` with your VPS address in the following `hostname` fields :
151```
152listen:
153 hostname: 'my-vps-address.net'
154 port: 9000
155
156webserver:
157 https: false
158 hostname: 'my-vps-address.net'
159 port: 9000
160```
161
162Then, you just need to listen to `https://my-vps-address.net:3000/` in your web browser.
163
164### Federation
165 137
166Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. 138Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
167Then, we can create the databases (if they don't already exist): 139Then, we can create the databases (if they don't already exist):
@@ -215,3 +187,11 @@ $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/te
215 187
216Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. 188Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
217Note that only instance 2 has transcoding enabled. 189Note that only instance 2 has transcoding enabled.
190
191### Troubleshooting
192
193Please check out the issues and [list of common errors](https://docs.joinpeertube.org/lang/en/devdocs/troubleshooting.html).
194
195### Tutorials
196
197Please check out the related section in the [development documentation](https://docs.joinpeertube.org/lang/en/devdocs/index.html#tutorials). Contribute tutorials at [framagit.org/framasoft/peertube/documentation](https://framagit.org/framasoft/peertube/documentation).