diff options
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r-- | .github/CONTRIBUTING.md | 55 |
1 files changed, 22 insertions, 33 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ca563edf6..b5d7ede72 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md | |||
@@ -2,13 +2,15 @@ | |||
2 | 2 | ||
3 | Interested in contributing? Awesome! | 3 | Interested 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 | 11 | * [Improve the website](#improve-the-website) | |
12 | * [Troubleshooting](#troubleshooting) | ||
13 | * [Tutorials](#tutorials) | ||
12 | 14 | ||
13 | ## Translate | 15 | ## Translate |
14 | 16 | ||
@@ -37,6 +39,15 @@ Some hints: | |||
37 | * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory | 39 | * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory |
38 | 40 | ||
39 | 41 | ||
42 | ## Improve the website | ||
43 | |||
44 | 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. | ||
45 | |||
46 | You can help us improve it too! | ||
47 | |||
48 | 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 | ||
49 | |||
50 | |||
40 | ## Develop | 51 | ## Develop |
41 | 52 | ||
42 | Don't hesitate to talk about features you want to develop by creating/commenting an issue | 53 | Don't hesitate to talk about features you want to develop by creating/commenting an issue |
@@ -122,37 +133,7 @@ and the web server is automatically restarted. | |||
122 | $ npm run dev | 133 | $ npm run dev |
123 | ``` | 134 | ``` |
124 | 135 | ||
125 | Depending on your OS, you may face the following error : | 136 | ### Testing the federation of PeerTube servers |
126 | ``` | ||
127 | $ [nodemon] Internal watch failed: ENOSPC: no space left on device, watch '/PeerTube/dist' | ||
128 | ``` | ||
129 | |||
130 | This 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 : | ||
131 | ``` | ||
132 | echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p | ||
133 | ``` | ||
134 | |||
135 | See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers | ||
136 | |||
137 | ### Configurations for VPS | ||
138 | |||
139 | If 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. | ||
140 | |||
141 | Next, 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 : | ||
142 | ``` | ||
143 | listen: | ||
144 | hostname: 'my-vps-address.net' | ||
145 | port: 9000 | ||
146 | |||
147 | webserver: | ||
148 | https: false | ||
149 | hostname: 'my-vps-address.net' | ||
150 | port: 9000 | ||
151 | ``` | ||
152 | |||
153 | Then, you just need to listen to `https://my-vps-address.net:3000/` in your web browser. | ||
154 | |||
155 | ### Federation | ||
156 | 137 | ||
157 | Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. | 138 | Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. |
158 | Then, we can create the databases (if they don't already exist): | 139 | Then, we can create the databases (if they don't already exist): |
@@ -206,3 +187,11 @@ $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/te | |||
206 | 187 | ||
207 | Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. | 188 | Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. |
208 | Note that only instance 2 has transcoding enabled. | 189 | Note that only instance 2 has transcoding enabled. |
190 | |||
191 | ### Troubleshooting | ||
192 | |||
193 | Please check out the issues and [list of common errors](https://docs.joinpeertube.org/lang/en/devdocs/troubleshooting.html). | ||
194 | |||
195 | ### Tutorials | ||
196 | |||
197 | Please 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). | ||