castopod/docs/src/de/getting-started/install.md

8.5 KiB
Raw Blame History

title sidebarDepth
Installation 3

Wie installiere ich Castopod?

Castopod ist für eine einfache Installation konzipiert. Ob dediziertes oder Shared-Hosting, du kannst es auf den meisten PHP-MySQL-kompatiblen Webservern installieren.

::: tip Note

Wir haben offizielle Docker Images für Castopod veröffentlicht!

Wenn du Docker bevorzugst, kannst du die manuelle Anleitung überspringen und direkt zur Docker-Dokumentation für Castopod gehen.

:::

Voraussetzungen

  • PHP v8.1 oder höher
  • MySQL Version 5.7 oder höher oder MariaDB Version 10.2 oder höher
  • HTTPS-Unterstützung
  • Eine ntp-synchronisierte Uhr um die eingehenden Anfragen zu überprüfen

PHP v8.1 oder höher

PHP Version 8.1 oder höher ist erforderlich, wobei folgende Erweiterungen installiert sind:

Stelle außerdem sicher, dass die folgenden Erweiterungen in deinem PHP aktiviert sind:

  • json (standardmäßig aktiviert - nicht ausschalten)
  • xml (standardmäßig aktiviert - nicht ausschalten)
  • mysqlnd

MySQL kompatible Datenbank

Wir empfehlen MariaDB.

::: warning Warning

Castopod funktioniert nur mit unterstützten MySQL 5.7 oder höher kompatiblen Datenbanken. Es wird zum Beispiel mit dem vorherigen MySQL v5.6 nicht mehr funktionieren, dessen Lebensende am 5. Februar 2021 war.

:::

Du benötigst den Servernamen, den Datenbanknamen, den Benutzernamen und das Passwort, um den Installationsvorgang abzuschließen. Kontaktiere bitte den Administrator, falls du keinen Benutzeraccount hast.

Berechtigungen

Benutzer müssen mindestens diese Berechtigungen in der Datenbank haben, damit Castopod funktioniert: CREATE, ALTER, DELETE, EXECUTE, INDEX, INSERT, SELECT, UPDATE, REFERENCES, CREATE VIEW.

(Optional) FFmpeg v4.1.8 oder höher für Videoclips

FFmpeg Version 4.1.8 oder höher ist erforderlich, wenn Du Videoclips generieren möchtest. Die folgenden Php-Erweiterungen sind nicht installiert: %s:

  • FreeType 2 Bibliothek für gd.

(Optional) Weitere Empfehlungen

  • Redis für bessere Cache-Leistungen.
  • CDN für das Caching statischer Dateien und bessere Leistungen.
  • E-Mail Server Anbindung für E-Mails zu verlorenen Passwörtern.

Installationsanleitung

Voraussetzungen

  1. Get a Web Server with requirements installed

  2. Create a MySQL database for Castopod with a user having access and modification privileges (for more info, see MySQL compatible database).

  3. Activate HTTPS on your domain with an SSL certificate.

  4. Download and unzip the latest Castopod Package onto the web server if you havent already.

    • ⚠️ Set the web server document root to the public/ sub-folder within the castopod folder.
  5. Add cron tasks on your web server for various background processes (replace the paths accordingly):

    • For social features to work properly, this task is used to broadcast social activities to your followers on the fediverse:
       * * * * * /path/to/php /path/to/castopod/public/index.php scheduled-activities
    
    • For having your episodes be broadcasted on open hubs upon publication using WebSub:
       * * * * * /usr/local/bin/php /castopod/public/index.php scheduled-websub-publish
    
       * * * * * /path/to/php /path/to/castopod/public/index.php scheduled-video-clips
    

    These tasks run every minute. You may set the frequency depending on your needs: every 5, 10 minutes or more.

  1. Run the Castopod install script by going to the install wizard page (https://your_domain_name.com/cp-install) in your favorite web browser.
  2. Follow the instructions on your screen.
  3. Start podcasting!

::: info Note

The install script writes a .env file in the package root. If you cannot go through the install wizard, you can create and edit the .env file manually based on the .env.example file.

:::

Email/SMTP setup

Email configuration is required for some features to work properly (eg. retrieving your forgotten password, sending instructions to premium subscribers, …)

You may add your email configuration in your instance's .env like so:

# […]

# […]

email.fromEmail="your_email_address"
email.SMTPHost="your_smtp_host"
email.SMTPUser="your_smtp_user"
email.SMTPPass="your_smtp_password"

Email config options

Variable name Type Default
fromEmail string undefined
fromName string "Castopod"
SMTPHost string undefined
SMTPUser string undefined
SMTPPass string undefined
SMTPPort number 25
SMTPCrypto ["tls" or "ssl"] "tls"

Media storage

By default, files are saved to the public/media folder using the file system. If you need to relocate the media folder to a different location, you can specify it in your .env file as shown below:

# […]

media.root="media"
media.storage="/mnt/storage"

In this example, the files will be saved to the /mnt/storage/media folder. Make sure to also update your web server configuration to reflect this change.

S3

If you prefer storing your media files on an S3 compatible storage, you may specify it in your .env:

# […]

media.fileManager="s3"
media.s3.endpoint="your_s3_host"
media.s3.key="your_s3_key"
media.s3.secret="your_s3_secret"
media.s3.region="your_s3_region"

S3 config options

Variable name Type Default
endpoint string undefined
key string undefined
secret string undefined
region string undefined
bucket string castopod
protocol number undefined
pathStyleEndpoint boolean false
keyPrefix string undefined

Community packages

If you don't want to bother with installing Castopod manually, you may use one of the packages created and maintained by the open-source community.

Install with YunoHost

YunoHost is a distribution based on Debian GNU/Linux made up of free and open-source software packages. It manages the hardships of self-hosting for you.