From 80c7336a896d9eb1e71b7c89a72285f914259457 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Brizard?= Date: Mon, 8 Oct 2018 13:25:41 +0200 Subject: (doc) explain common watcher inotify error in CONTRIBUTING.md (#1223) --- .github/CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to '.github/CONTRIBUTING.md') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4b352922e..a25368cdb 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -122,6 +122,18 @@ and the web server is automatically restarted. $ npm run dev ``` +Depending on your OS, you may face the following error : +``` +$ [nodemon] Internal watch failed: ENOSPC: no space left on device, watch '/PeerTube/dist' +``` + +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 : +``` +echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p +``` + +See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers + ### Federation Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. -- cgit v1.2.3 From e730aef76abe02485f417ecef99da2c3b760edc4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20B=C3=A9ranger?= <43744761+auberanger@users.noreply.github.com> Date: Wed, 24 Oct 2018 00:16:47 +0200 Subject: (doc) add VPS as development platform example in CONTRIBUTING.md (#1278) --- .github/CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to '.github/CONTRIBUTING.md') 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 See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers +### Configurations for VPS + +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. + +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 : +``` +listen: + hostname: 'my-vps-address.net' + port: 9000 + +webserver: + https: false + hostname: 'my-vps-address.net' + port: 9000 +``` + +Then, you just need to listen to `https://my-vps-address.net:3000/` in your web browser. + ### Federation Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. -- cgit v1.2.3 From 71607e4a65d3a8904bcd418ab7acbc2f34f725ff Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Wed, 24 Oct 2018 23:39:52 +0200 Subject: fix typo in CONTRIBUTING.md --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github/CONTRIBUTING.md') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d895304a4..ca563edf6 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Welcome to the contributing guide for PeerTube -Interesting in contributing? Awesome! +Interested in contributing? Awesome! **Quick Links:** -- cgit v1.2.3 From 0e62b72bb9dba17b2cf57091f941db679aaf635c Mon Sep 17 00:00:00 2001 From: Thomas Kuntz Date: Sat, 3 Nov 2018 15:00:10 +0100 Subject: Add 'Improve the website' section to CONTRIBUTING (#1366) --- .github/CONTRIBUTING.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to '.github/CONTRIBUTING.md') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ca563edf6..cbd628c25 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,7 +8,7 @@ Interested in contributing? Awesome! * [Give your feedback](#give-your-feedback) * [Write documentation](#write-documentation) * [Develop](#develop) - + * [Improve the website](#improve-the-website) ## Translate @@ -37,6 +37,15 @@ Some hints: * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory +## Improve the website + +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. + +You can help us improve it too! + +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 + + ## Develop Don't hesitate to talk about features you want to develop by creating/commenting an issue -- cgit v1.2.3 From e2266e4f822a2dd91c1247829b96b881ccb63e0b Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Fri, 9 Nov 2018 14:51:08 +0100 Subject: update CONTRIBUTING.md to reflect new documentation sections --- .github/CONTRIBUTING.md | 44 ++++++++++++-------------------------------- 1 file changed, 12 insertions(+), 32 deletions(-) (limited to '.github/CONTRIBUTING.md') 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 @@ Interested in contributing? Awesome! -**Quick Links:** +**This guide will present you the following contribution topics:** * [Translate](#translate) * [Give your feedback](#give-your-feedback) * [Write documentation](#write-documentation) * [Develop](#develop) * [Improve the website](#improve-the-website) + * [Troubleshooting](#troubleshooting) + * [Tutorials](#tutorials) ## Translate @@ -131,37 +133,7 @@ and the web server is automatically restarted. $ npm run dev ``` -Depending on your OS, you may face the following error : -``` -$ [nodemon] Internal watch failed: ENOSPC: no space left on device, watch '/PeerTube/dist' -``` - -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 : -``` -echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p -``` - -See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers - -### Configurations for VPS - -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. - -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 : -``` -listen: - hostname: 'my-vps-address.net' - port: 9000 - -webserver: - https: false - hostname: 'my-vps-address.net' - port: 9000 -``` - -Then, you just need to listen to `https://my-vps-address.net:3000/` in your web browser. - -### Federation +### Testing the federation of PeerTube servers Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. Then, 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 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. Note that only instance 2 has transcoding enabled. + +### Troubleshooting + +Please check out the issues and [list of common errors](https://docs.joinpeertube.org/lang/en/devdocs/troubleshooting.html). + +### Tutorials + +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). -- cgit v1.2.3