From 67b73c15257558b0a6c37b30c226d05973e89795 Mon Sep 17 00:00:00 2001
From: Yassine Doghri <yassine@doghri.fr>
Date: Sat, 22 Jan 2022 14:44:07 +0000
Subject: [PATCH] docs: update install, update and readme for next release
fix translation files
---
INSTALL.md | 33 +++++++++++++++----
README.md | 15 ++++-----
UPDATE.md | 6 ++--
modules/Admin/Language/en/Navigation.php | 2 +-
.../Admin/Language/en/PodcastNavigation.php | 2 +-
modules/Admin/Language/fr/Navigation.php | 2 +-
.../Admin/Language/fr/PodcastNavigation.php | 2 +-
7 files changed, 40 insertions(+), 22 deletions(-)
diff --git a/INSTALL.md b/INSTALL.md
index 639961c41d..7734034d9e 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -11,6 +11,7 @@ or shared hosting, you can install it on most PHP-MySQL compatible web servers.
- [(alternative) Manual configuration](#alternative-manual-configuration)
- [Web Server Requirements](#web-server-requirements)
- [PHP v8.0 or higher](#php-v80-or-higher)
+ - [FFmpeg v4.1.8 or higher for Video Clips](#ffmpeg-v418-or-higher-for-video-clips)
- [MySQL compatible database](#mysql-compatible-database)
- [Privileges](#privileges)
- [(Optional) Other recommendations](#optional-other-recommendations)
@@ -20,24 +21,34 @@ or shared hosting, you can install it on most PHP-MySQL compatible web servers.
### 0. Pre-requisites
-0. Get a Web Server with requirements installed
+0. Get a Web Server with [requirements](#web-server-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](#web-server-requirements)).
+ [MySQL compatible database](#mysql-compatible-database)).
2. Activate HTTPS on your domain with an _SSL certificate_.
3. Download and unzip the latest
[Castopod Host Package](https://code.podlibre.org/podlibre/castopod-host/-/releases)
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):
+4. Add **cron tasks** on your web server for various background processes
+ (replace the paths accordingly):
- ```php
+ - For social features to work properly, this task is used to broadcast social
+ activities to your followers on the fediverse:
+
+ ```bash
* * * * * /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.
+ - For Video Clips to be created (see
+ [FFmpeg requirements](#ffmpeg-v418-or-higher-for-video-clips)):
+
+ ```bash
+ * * * * * /path/to/php /path/to/castopod-host/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.
### (recommended) Install Wizard
@@ -78,6 +89,14 @@ Additionally, make sure that the following extensions are enabled in your PHP:
- xml (enabled by default - don't turn it off)
- [mysqlnd](https://php.net/manual/en/mysqlnd.install.php)
+### FFmpeg v4.1.8 or higher for Video Clips
+
+[FFmpeg](https://www.ffmpeg.org/) version 4.1.8 or higher is required, with the
+following extensions:
+
+- **FreeType 2** library for
+ [gd](https://www.php.net/manual/en/image.installation.php).
+
### MySQL compatible database
> We recommend using [MariaDB](https://mariadb.org).
diff --git a/README.md b/README.md
index ba68c34bc4..eba42b47f4 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,12 @@
-<h1 style="text-align: center">
- <img src="https://podlibre.org/static/images/Castopod-Title.svg" alt="Castopod Host" />
+<h1 align="center">
+ <a href="https://castopod.org/">
+ <img src="https://podlibre.org/static/images/Castopod-Title.svg" alt="Castopod Host" />
+ </a>
</h1>
-> âš ï¸ **Castopod Host is in alpha version**. It is still under heavy development
-> and may not be 100% stable as new features are being worked on.
+> **Castopod Host is in beta version**. We are working on getting the last
+> features needed for v1, making performance improvements and fixing any bugs
+> that may arise along the way.
_Castopod Host_ is a free and open-source podcast hosting solution made for
podcasters who want engage and interact with their audience.
@@ -14,10 +17,6 @@ audience measurements that respect your listeners privacy.
Whether you choose to install it on your own server or have it hosted by a
professional, all your data and analytics belong to you and you only!
-<div style="text-align: center">
- <img src="https://podlibre.org/static/images/Castopod-Mascot-Server.svg" alt="Castopod Mascot" />
-</div>
-
You may find Castopod Host's source code on the
[original repository](https://code.podlibre.org/podlibre/castopod-host) or,
alternatively, on the
diff --git a/UPDATE.md b/UPDATE.md
index 1185b00b58..a7cafe6d80 100644
--- a/UPDATE.md
+++ b/UPDATE.md
@@ -37,7 +37,7 @@ performance improvements âš¡.
process. Check
[Security Concerns section in INSTALL.md](./INSTALL.md#security-concerns).
-4. Alpha releases may come with additional update instructions (see
+4. Releases may come with additional update instructions (see
[releases page](https://code.podlibre.org/podlibre/castopod-host/-/releases)).
They are usually database migration scripts in `.sql` format to update your
database schema.
@@ -74,7 +74,7 @@ to the newest.
> _Castopod Host_.
For example, if you're on `v1.0.0-alpha.42` and would like to upgrade to
-`v1.0.0-alpha.58`:
+`v1.0.0-beta.1`:
0. (recommended) Make a backup of your files and database.
@@ -83,7 +83,7 @@ For example, if you're on `v1.0.0-alpha.42` and would like to upgrade to
2. Go through each release update instructions sequentially (from oldest to
newest) starting with `v1.0.0-alpha.43`, `v1.0.0-alpha.44`,
- `v1.0.0-alpha.45`, …, `v1.0.0-alpha.58`.
+ `v1.0.0-alpha.45`, …, `v1.0.0-beta.1`.
3. ✨ Enjoy your fresh instance, you're all done!
diff --git a/modules/Admin/Language/en/Navigation.php b/modules/Admin/Language/en/Navigation.php
index 716190e444..6d171d5530 100644
--- a/modules/Admin/Language/en/Navigation.php
+++ b/modules/Admin/Language/en/Navigation.php
@@ -10,7 +10,7 @@ declare(strict_types=1);
return [
'toggle_sidebar' => 'Toggle sidebar',
- 'go_to_website' => 'View site',
+ 'go_to_website' => 'Go to website',
'go_to_admin' => 'Go to admin',
'dashboard' => 'Dashboard',
'admin' => 'Home',
diff --git a/modules/Admin/Language/en/PodcastNavigation.php b/modules/Admin/Language/en/PodcastNavigation.php
index 66cfce54f6..94f15538cc 100644
--- a/modules/Admin/Language/en/PodcastNavigation.php
+++ b/modules/Admin/Language/en/PodcastNavigation.php
@@ -30,6 +30,6 @@ return [
'contributor-add' => 'Add contributor',
'platforms' => 'External platforms',
'platforms-podcasting' => 'Podcasting',
- 'platforms-social' => 'Social Networks',
+ 'platforms-social' => 'Social networks',
'platforms-funding' => 'Funding',
];
diff --git a/modules/Admin/Language/fr/Navigation.php b/modules/Admin/Language/fr/Navigation.php
index a975bb6dbf..aca491a9d4 100644
--- a/modules/Admin/Language/fr/Navigation.php
+++ b/modules/Admin/Language/fr/Navigation.php
@@ -10,7 +10,7 @@ declare(strict_types=1);
return [
'toggle_sidebar' => 'Afficher ou cacher la barre latérale',
- 'go_to_website' => 'Visiter le site',
+ 'go_to_website' => 'Aller au site',
'go_to_admin' => 'Aller à l’admin',
'dashboard' => 'Tableau de bord',
'admin' => 'Accueil',
diff --git a/modules/Admin/Language/fr/PodcastNavigation.php b/modules/Admin/Language/fr/PodcastNavigation.php
index c22fd12b6d..af1b62a782 100644
--- a/modules/Admin/Language/fr/PodcastNavigation.php
+++ b/modules/Admin/Language/fr/PodcastNavigation.php
@@ -30,6 +30,6 @@ return [
'contributor-add' => 'Ajouter un contributeur',
'platforms' => 'Plate-formes externes',
'platforms-podcasting' => 'Podcasts',
- 'platforms-social' => 'Réseaux Sociaux',
+ 'platforms-social' => 'Réseaux sociaux',
'platforms-funding' => 'Financement',
];
--
GitLab