aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc
diff options
context:
space:
mode:
Diffstat (limited to 'support/doc')
-rw-r--r--support/doc/api/openapi.yaml18
-rw-r--r--support/doc/dependencies.md45
-rw-r--r--support/doc/plugins/guide.md39
3 files changed, 84 insertions, 18 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 99a725ead..76e78fe53 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -716,7 +716,7 @@ paths:
716 - admin 716 - admin
717 tags: 717 tags:
718 - Instance Follows 718 - Instance Follows
719 summary: Follow a list of servers 719 summary: Follow a list of actors (PeerTube instance, channel or account)
720 responses: 720 responses:
721 '204': 721 '204':
722 description: successful operation 722 description: successful operation
@@ -734,28 +734,32 @@ paths:
734 type: string 734 type: string
735 format: hostname 735 format: hostname
736 uniqueItems: true 736 uniqueItems: true
737 handles:
738 type: array
739 items:
740 type: string
741 uniqueItems: true
737 742
738 '/server/following/{host}': 743 '/server/following/{hostOrHandle}':
739 delete: 744 delete:
740 summary: Unfollow a server 745 summary: Unfollow an actor (PeerTube instance, channel or account)
741 security: 746 security:
742 - OAuth2: 747 - OAuth2:
743 - admin 748 - admin
744 tags: 749 tags:
745 - Instance Follows 750 - Instance Follows
746 parameters: 751 parameters:
747 - name: host 752 - name: hostOrHandle
748 in: path 753 in: path
749 required: true 754 required: true
750 description: The host to unfollow 755 description: The hostOrHandle to unfollow
751 schema: 756 schema:
752 type: string 757 type: string
753 format: hostname
754 responses: 758 responses:
755 '204': 759 '204':
756 description: successful operation 760 description: successful operation
757 '404': 761 '404':
758 description: host not found 762 description: host or handle not found
759 763
760 /users: 764 /users:
761 post: 765 post:
diff --git a/support/doc/dependencies.md b/support/doc/dependencies.md
index 8ea0c047d..d6c084cd7 100644
--- a/support/doc/dependencies.md
+++ b/support/doc/dependencies.md
@@ -151,6 +151,51 @@ sudo systemctl enable --now redis
151sudo systemctl enable --now postgresql 151sudo systemctl enable --now postgresql
152``` 152```
153 153
154## Rocky Linux 8.4
155
1561. Pull the latest updates:
157```
158sudo dnf update -y
159```
160
1612. Install NodeJS 12.x (why 12 and not 14? Not sure...):
162```
163sudo dnf module install -y nodejs:12
164```
165
1663. Install yarn:
167```
168sudo npm install --global yarn
169```
170
1714. Install or compile ffmpeg (if you want to compile... enjoy):
172```
173sudo dnf install -y epel-release
174sudo dnf --enablerepo=powertools install -y SDL2 SDL2-devel
175sudo dnf install -y --nogpgcheck https://download1.rpmfusion.org/free/el/rpmfusion-free-release-8.noarch.rpm https://download1.rpmfusion.org/nonfree/el/rpmfusion-nonfree-release-8.noarch.rpm
176sudo dnf install -y ffmpeg
177sudo dnf update -y
178```
179
1805. Install PostgreSQL and Python3 and other stuff:
181```
182sudo dnf install -y nginx postgresql postgresql-server postgresql-contrib openssl gcc-c++ make wget redis git python3
183sudo ln -s /usr/bin/python3 /usr/bin/python
184sudo PGSETUP_INITDB_OPTIONS='--auth-host=md5' postgresql-setup --initdb --unit postgresql
185sudo systemctl enable --now redis
186sudo systemctl enable --now postgresql
187```
188
1896. Configure the peertube user:
190```
191sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
192```
193
1947. Unknown missing steps:
195- Steps missing here... these were adapted from the CentOS 8 steps which abruptly ended.
196- /var/www/peertube does not exist yet (expected? done in future steps? documentation?).
197- Nothing about Certbot, NGINX, Firewall settings, and etc.
198- Hopefully someone can suggest what is missing here with some hints so I can add it?
154 199
155## Fedora 200## Fedora
156 201
diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md
index 568c0662f..072c7c6ca 100644
--- a/support/doc/plugins/guide.md
+++ b/support/doc/plugins/guide.md
@@ -180,6 +180,15 @@ function register (...) {
180 type: 'input', 180 type: 'input',
181 // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html' 181 // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html'
182 182
183 // If type: 'select', give the select available options
184 options: [
185 { label: 'Label 1', value: 'value1' },
186 { label: 'Label 2', value: 'value2' }
187 ],
188
189 // If type: 'html', set the HTML that will be injected in the page
190 html: '<strong class="...">Hello</strong><br /><br />'
191
183 // Optional 192 // Optional
184 descriptionHTML: 'The purpose of this field is...', 193 descriptionHTML: 'The purpose of this field is...',
185 194
@@ -196,7 +205,7 @@ function register (...) {
196 result['admin-name] 205 result['admin-name]
197 206
198 settingsManager.onSettingsChange(settings => { 207 settingsManager.onSettingsChange(settings => {
199 settings['admin-name]) 208 settings['admin-name']
200 }) 209 })
201} 210}
202``` 211```
@@ -234,21 +243,29 @@ function register ({
234 243
235#### Update video constants 244#### Update video constants
236 245
237You can add/delete video categories, licences or languages using the appropriate managers: 246You can add/delete video categories, licences or languages using the appropriate constant managers:
238 247
239```js 248```js
240function register (...) { 249function register ({
241 videoLanguageManager.addLanguage('al_bhed', 'Al Bhed') 250 videoLanguageManager,
242 videoLanguageManager.deleteLanguage('fr') 251 videoCategoryManager,
252 videoLicenceManager,
253 videoPrivacyManager,
254 playlistPrivacyManager
255}) {
256 videoLanguageManager.addConstant('al_bhed', 'Al Bhed')
257 videoLanguageManager.deleteConstant('fr')
243 258
244 videoCategoryManager.addCategory(42, 'Best category') 259 videoCategoryManager.addConstant(42, 'Best category')
245 videoCategoryManager.deleteCategory(1) // Music 260 videoCategoryManager.deleteConstant(1) // Music
261 videoCategoryManager.resetConstants() // Reset to initial categories
262 videoCategoryManager.getConstants() // Retrieve all category constants
246 263
247 videoLicenceManager.addLicence(42, 'Best licence') 264 videoLicenceManager.addConstant(42, 'Best licence')
248 videoLicenceManager.deleteLicence(7) // Public domain 265 videoLicenceManager.deleteConstant(7) // Public domain
249 266
250 videoPrivacyManager.deletePrivacy(2) // Remove Unlisted video privacy 267 videoPrivacyManager.deleteConstant(2) // Remove Unlisted video privacy
251 playlistPrivacyManager.deletePlaylistPrivacy(3) // Remove Private video playlist privacy 268 playlistPrivacyManager.deleteConstant(3) // Remove Private video playlist privacy
252} 269}
253``` 270```
254 271