dataset/seed/peertube/README.md

Table of Contents

• peertube
• Synopsis
• Example
• Basic variables
• General
• Reverse proxy
• Clients configuration
• peertube
• Variables
• General
• Reverse proxy
• Clients configuration
• OAuth2 client
• external
• peertube
• Variables for expert
• General
• NGINX
• Requirements services
• Mandatories
• Optionals
• Dependances

Return to the list of application services.

peertube

Synopsis

Peertube, a federated (ActivityPub) video streaming platform.

Example

Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.

peertube:
  applicationservice: peertube
  zones_name:
    - externaldns
    - oauth2
    - postgresql
    - redis
    - reverseproxy
    - smtp
  values:
    general.revprox.revprox_client.revprox_client_external_domainnames:
      - service.example.net
    general.peertube.peertube_admin_email: john.doe@example.net

Basic variables

General

Reverse proxy

Clients configuration

This family is a leadership.

Parameter	Comment
general.revprox.revprox_client.revprox_client_external_domainnames mandatory, multiple Type: domainname	Service external domain name. Example: service.example.net
general.revprox.revprox_client.revprox_client_location mandatory Type: filename	URI to route request to the correct service. Default: /

peertube

Parameter	Comments
general.peertube.peertube_admin_email mandatory Type: mail	Adresse courriel de l'administrateur Peertube. Example: john.doe@example.net

Variables

General

Reverse proxy

Clients configuration

This family is a leadership.

Parameter	Comment
general.revprox.revprox_client.revprox_client_max_body_size mandatory Type: string	The maximum allowed size of the client request body. Default: 12G

OAuth2 client

Parameter	Comment
general.oauth2_client.oauth2_client_name mandatory Type: string	OAuth2 client name. Default: Vidéo Example: example
general.oauth2_client.oauth2_client_description mandatory Type: string	OAuth2 client description. Default: Plateforme de partage de vidéo Peertube Example: Example description
general.oauth2_client.oauth2_client_login Type: web_address	OAuth2 URL to valid login.

external

Parameter	Comments
general.oauth2_client.external.oauth2_client_external mandatory, multiple Type: web_address	OAuth2 client external. Default: calculated
general.oauth2_client.external.oauth2_client_family mandatory Type: string	OAuth2 family. Default: users

Parameter	Comment
general.oauth2_client.oauth2_client_category mandatory Type: string	OAuth2 category. Default: Réseaux sociaux
general.oauth2_client.oauth2_client_logo mandatory Type: string	OAuth2 logo. Default: silique_video.png

peertube

Parameter	Comments
general.peertube.peertube_short_description mandatory Type: string	Description courte de l'instance. Default: PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.
general.peertube.peertube_description mandatory Type: string	Description de l'instance. Default: Welcome to this PeerTube instance!

Variables for expert

General

NGINX

Parameter	Comment
general.nginx.nginx_hash_bucket_size mandatory Type: choice	The bucket size for the server names hash tables. Choices: - 128 ← default - 64 - 32
general.nginx.nginx_post_max_size mandatory Type: number	The maximum allowed size of the client request body. This value is in Mb. Default: 32

Requirements services

Mandatories

• SMTP: Create a SMTP relay account and authorize sending email.
• ReverseProxy: Register to service to a reverse proxy server.
• Postgresql: Create account and connexion to a PostgreSQL server.
• OAuth2: Remote clients needing to verify OAuth2 account.
• ExternalDNS: DNS forwarder for all DNS zones.
• Redis: Create account and connexion to a Redis server.

Optionals

• Journald: Concentrate journal messages on one host.

Dependances

• base-fedora-38: Base information of a Fedora 38.
  • base-fedora: Base information of a Fedora.
    • systemd: Systemd, a system and service manager.
      • base-machine: Base information for a machine.
        • base: Base of all application services.
        • dns-local: DNS client with access to local zones.
        • pki-tls: Autosign PKI or Let's encrypt support for TLS certificates.
      • journald: Journald.
      • resolved: Resolved.
• dns-external: DNS client with resolution on all zones (especially outside).
• postgresql-client: Application service needs interact with a Postgresql server.
• relay-mail-client: Client SMTP.
• reverse-proxy-client: Application service needs interact with a a reverse proxy server.
• redis-client: Application service needs interact with a Redis server.
  • redis-common: Redis, an in-memory data structure store.
• nginx-https: Nginx as HTTPS web site.
  • nginx-common: Nginx common configuration.
  • reverse-proxy-client: Application service needs interact with a a reverse proxy server.
• oauth2-client: Application service needs interact with a Oauth2 server.