-
Yassine Doghri authored
docs: update INSTALL.md to include SSL certificate requirement + update install instructions
Yassine Doghri authoreddocs: update INSTALL.md to include SSL certificate requirement + update install instructions
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
-
Get a Web Server with requirements installed
-
Create a MySQL database for Castopod Host with a user having access and modification privileges (for more info, see Web Server Requirements).
-
Activate HTTPS on your domain with an SSL certificate.
-
Download and unzip the latest Castopod Host Package onto the web server if you haven’t already.
-
⚠️ Set the web server document root to thepublic/
sub-folder.
-
-
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.
1. Install Wizard
- 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. - Follow the instructions on your screen.
- Start podcasting!
1-alt Manual configuration
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 yourself:
- Rename the
.env.example
file to.env
and update the default values with your own. - Upload the
.env
file to the Castopod Host Package root on your server. - Go to
/cp-install
to finish the install process. - Start podcasting!
Web Server Requirements
PHP v7.3 or higher
PHP version 7.3 or higher is required, with the following extensions installed:
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.