INSTALL.md

How to install Castopod Host

Castopod Host was thought-out to be easy to install. Whether using dedicated or shared hosting, you can install it on most PHP-MySQL compatible web servers.

Table of contents

• Install instructions
  • 0. Pre-requisites
  • (recommended) Install Wizard
  • (alternative) Manual configuration
• Web Server Requirements
  • PHP v8.0 or higher
  • MySQL compatible database
    • Privileges
  • (Optional) Other recommendations
• Security concerns

Install instructions

0. Pre-requisites

0. Get a Web Server with requirements installed

1. Create a MySQL database for Castopod Host with a user having access and modification privileges (for more info, see Web Server Requirements).

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

3. Download and unzip the latest Castopod Host Package onto the web server if you haven’t already.

   • ⚠️ Set the web server document root to the public/ sub-folder.

4. Add a cron task on your web server to run every minute (replace the paths accordingly):

      * * * * * /path/to/php /path/to/castopod-host/public/index.php scheduled-activities

   ⚠️ Social features will not work properly if you do not set the task. It is used to broadcast social activities to the fediverse.

(recommended) Install Wizard

1. Run the Castopod Host 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!

Note:

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

(alternative) Manual configuration

1. Rename the .env.example file to .env and update the default values with your own.
2. Upload the .env file to the Castopod Host Package root on your server.
3. Go to /cp-install to finish the install process.
4. Start podcasting!

Web Server Requirements

PHP v8.0 or higher

PHP version 8.0 or higher is required, with the following extensions installed:

• intl
• libcurl
• mbstring
• gd

Additionally, make sure that the following extensions are enabled in your PHP:

• json (enabled by default - don't turn it off)
• xml (enabled by default - don't turn it off)
• mysqlnd

MySQL compatible database

We recommend using MariaDB.