
- rename all occurences of castopod to castopod host - docs: update contribution guidelines - docs: update README to include guidance for help and links to socials - remove castopod_namespace.json
3.8 KiB
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
-
Create a MySQL database for Castopod Host with a user having access and modification privileges (for more info, see Web Server Requirements).
-
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.
- ⚠️ Set the web server document root to the
-
For broadcasting social activities to the fediverse, 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
-
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.
All done, start podcasting!
(optional) Manual configuration
Before uploading Castopod Host files to your web server:
- Rename the
.env.example
file to.env
and update the default values with your own. - Upload the Castopod Host files with
.env
- Go to
/cp-install
to finish the install process.
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
You will need the server hostname, database name, username and password to complete the installation process. If you do not have these, please contact your server administrator.
Privileges
User must have at least these privileges on the database for Castopod Host to
work: ALTER
, DELETE
, EXECUTE
, INDEX
, INSERT
, SELECT
, UPDATE
.
(Optional) Other recommendations
- Redis for better cache performances.
- CDN for better performances.
- e-mail gateway for lost passwords.
Security concerns
Castopod Host is built on top of Codeigniter, a PHP framework that encourages good security practices.
To maximize your instance safety and prevent any malicious attack, we recommend you update all your Castopod Host files permissions after installation (to avoid any permission error):
writable/
folder must be readable and writable.public/media/
folder must be readable and writable.- any other file must be set to readonly.
For instance, if you are using Apache or NGINX with Ubuntu you may do the following:
sudo chown -R root:root /path/to/castopod-host
sudo chown -R www-data:www-data /path/to/castopod-host/writable
sudo chown -R www-data:www-data /path/to/castopod-host/public/media