From 7a07da01c4009cf0697ec5cfa78e32b187b0e8b6 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Wed, 28 Dec 2022 10:29:37 +0100 Subject: [PATCH] Improve upgrade documentation --- .../notifications/moderation-notifications.ts | 22 ++++++------ support/doc/production.md | 34 +++++++++++-------- 2 files changed, 31 insertions(+), 25 deletions(-) diff --git a/server/tests/api/notifications/moderation-notifications.ts b/server/tests/api/notifications/moderation-notifications.ts index b127a7a31..df239f92e 100644 --- a/server/tests/api/notifications/moderation-notifications.ts +++ b/server/tests/api/notifications/moderation-notifications.ts @@ -34,7 +34,7 @@ describe('Test moderation notifications', function () { let emails: object[] = [] before(async function () { - this.timeout(120000) + this.timeout(50000) const res = await prepareNotificationsTest(3) emails = res.emails @@ -60,7 +60,7 @@ describe('Test moderation notifications', function () { }) it('Should not send a notification to moderators on local abuse reported by an admin', async function () { - this.timeout(20000) + this.timeout(50000) const name = 'video for abuse ' + buildUUID() const video = await servers[0].videos.upload({ token: userToken1, attributes: { name } }) @@ -72,7 +72,7 @@ describe('Test moderation notifications', function () { }) it('Should send a notification to moderators on local video abuse', async function () { - this.timeout(20000) + this.timeout(50000) const name = 'video for abuse ' + buildUUID() const video = await servers[0].videos.upload({ token: userToken1, attributes: { name } }) @@ -84,7 +84,7 @@ describe('Test moderation notifications', function () { }) it('Should send a notification to moderators on remote video abuse', async function () { - this.timeout(20000) + this.timeout(50000) const name = 'video for abuse ' + buildUUID() const video = await servers[0].videos.upload({ token: userToken1, attributes: { name } }) @@ -99,7 +99,7 @@ describe('Test moderation notifications', function () { }) it('Should send a notification to moderators on local comment abuse', async function () { - this.timeout(20000) + this.timeout(50000) const name = 'video for abuse ' + buildUUID() const video = await servers[0].videos.upload({ token: userToken1, attributes: { name } }) @@ -118,7 +118,7 @@ describe('Test moderation notifications', function () { }) it('Should send a notification to moderators on remote comment abuse', async function () { - this.timeout(20000) + this.timeout(50000) const name = 'video for abuse ' + buildUUID() const video = await servers[0].videos.upload({ token: userToken1, attributes: { name } }) @@ -140,7 +140,7 @@ describe('Test moderation notifications', function () { }) it('Should send a notification to moderators on local account abuse', async function () { - this.timeout(20000) + this.timeout(50000) const username = 'user' + new Date().getTime() const { account } = await servers[0].users.create({ username, password: 'donald' }) @@ -153,7 +153,7 @@ describe('Test moderation notifications', function () { }) it('Should send a notification to moderators on remote account abuse', async function () { - this.timeout(20000) + this.timeout(50000) const username = 'user' + new Date().getTime() const tmpToken = await servers[0].users.generateUserAndToken(username) @@ -500,7 +500,7 @@ describe('Test moderation notifications', function () { }) it('Should send notification to moderators on new video with auto-blacklist', async function () { - this.timeout(120000) + this.timeout(50000) videoName = 'video with auto-blacklist ' + buildUUID() const video = await servers[0].videos.upload({ token: userToken1, attributes: { name: videoName } }) @@ -545,7 +545,7 @@ describe('Test moderation notifications', function () { }) it('Should send unblacklist but not published/subscription notes after unblacklisted if scheduled update pending', async function () { - this.timeout(120000) + this.timeout(50000) const updateAt = new Date(new Date().getTime() + 1000000) @@ -601,7 +601,7 @@ describe('Test moderation notifications', function () { }) it('Should not send a notification to moderators on new video without auto-blacklist', async function () { - this.timeout(120000) + this.timeout(50000) const name = 'video without auto-blacklist ' + buildUUID() diff --git a/support/doc/production.md b/support/doc/production.md index dd57e9120..9a84f19a3 100644 --- a/support/doc/production.md +++ b/support/doc/production.md @@ -177,16 +177,17 @@ $ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf If you plan to have many concurrent viewers on your PeerTube instance, consider increasing `worker_connections` value: https://nginx.org/en/docs/ngx_core_module.html#worker_connections. -**FreeBSD** +
+If using FreeBSD + On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/) ```bash $ sudo pkg install dehydrated ``` +
-### :alembic: TCP/IP Tuning - -**On Linux** +### :alembic: Linux TCP/IP Tuning ```bash $ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/ @@ -231,7 +232,9 @@ $ sudo systemctl start peertube $ sudo journalctl -feu peertube ``` -**FreeBSD** +
+If using FreeBSD + On FreeBSD, copy the startup script and update rc.conf: ```bash @@ -244,8 +247,10 @@ Run: ```bash $ sudo service peertube start ``` +
-### :bricks: OpenRC +
+If using OpenRC If your OS uses OpenRC, copy the service script: @@ -265,6 +270,7 @@ Run and print last logs: $ sudo /etc/init.d/peertube start $ tail -f /var/log/peertube/peertube.log ``` +
### :technologist: Administrator @@ -291,16 +297,15 @@ Now your instance is up you can: **Check the changelog (in particular the *IMPORTANT NOTES* section):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md -#### Auto - -The password it asks is PeerTube's database user password. +Run the upgrade script (the password it asks is PeerTube's database user password): ```bash $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh $ sudo systemctl restart peertube # Or use your OS command to restart PeerTube if you don't use systemd ``` -#### Manually +
+Prefer manual upgrade? Make a SQL backup @@ -346,17 +351,18 @@ $ cd /var/www/peertube && \ sudo unlink ./peertube-latest && \ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest ``` +
-### Configuration +### Update PeerTube configuration -You can check for configuration changes, and report them in your `config/production.yaml` file: +Check for configuration changes, and report them in your `config/production.yaml` file: ```bash $ cd /var/www/peertube/versions $ diff -u "$(ls --sort=t | head -2 | tail -1)/config/production.yaml.example" "$(ls --sort=t | head -1)/config/production.yaml.example" ``` -### nginx +### Update nginx configuration Check changes in nginx configuration: @@ -365,7 +371,7 @@ $ cd /var/www/peertube/versions $ diff -u "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube" ``` -### systemd +### Update systemd service Check changes in systemd configuration: