aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAurélien Béranger <43744761+auberanger@users.noreply.github.com>2018-10-24 00:16:47 +0200
committerRigel Kent <par@rigelk.eu>2018-10-24 00:16:47 +0200
commite730aef76abe02485f417ecef99da2c3b760edc4 (patch)
tree97b06c10943a462eb4c578fd0be2fc35003ca885
parent5e10e8d73a19ed38aeb26d7e57b96d5843e7136d (diff)
downloadPeerTube-e730aef76abe02485f417ecef99da2c3b760edc4.tar.gz
PeerTube-e730aef76abe02485f417ecef99da2c3b760edc4.tar.zst
PeerTube-e730aef76abe02485f417ecef99da2c3b760edc4.zip
(doc) add VPS as development platform example in CONTRIBUTING.md (#1278)
-rw-r--r--.github/CONTRIBUTING.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index a25368cdb..d895304a4 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -134,6 +134,24 @@ echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo s
134 134
135See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers 135See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers
136 136
137### Configurations for VPS
138
139If 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
141Next, 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```
143listen:
144 hostname: 'my-vps-address.net'
145 port: 9000
146
147webserver:
148 https: false
149 hostname: 'my-vps-address.net'
150 port: 9000
151```
152
153Then, you just need to listen to `https://my-vps-address.net:3000/` in your web browser.
154
137### Federation 155### Federation
138 156
139Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. 157Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.