docs: use generic example.com domain in samples and docs
This commit is contained in:
+20
-20
@@ -42,8 +42,8 @@ Cette application est un *fork* de https://labola.o-k-i.net/ORGANISATION-KA-INTE
|
||||
| Dépôt de ce fork
|
||||
| `git@labola.o-k-i.net:cedric/annu-kute-ced.git`
|
||||
|
||||
| Domaine de production
|
||||
| https://annukuteced.buzz
|
||||
| Domaine (exemple)
|
||||
| https://example.com
|
||||
|
||||
| Gouvernance
|
||||
| Application maintenue par OKI ; fork porté par le propriétaire du dépôt *cedric* (Cédric Famibelle-Pronzola)
|
||||
@@ -267,7 +267,7 @@ cp dons.php.sample dons.php
|
||||
. 🛡️ Installez la configuration serveur sécurisée depuis `conf/` (voir <<fr-securite,Sécurité>>).
|
||||
. ✍️ Rendez le dossier `cache/` accessible en écriture par le serveur web (créé automatiquement au premier appel API).
|
||||
. 🔒 Assurez-vous que HTTPS est actif (obligatoire pour la PWA).
|
||||
. 🌐 Faites pointer votre domaine (`annukuteced.buzz`) vers la racine du projet.
|
||||
. 🌐 Faites pointer votre domaine (ex. `example.com`) vers la racine du projet.
|
||||
|
||||
[[fr-configuration]]
|
||||
=== ⚙️ Configuration
|
||||
@@ -308,7 +308,7 @@ Valeurs par défaut issues de `includes/config.default.php`.
|
||||
| Constante | Défaut | Description
|
||||
|
||||
| `APP_HOST_NAME`
|
||||
| `'annukuteced.buzz'`
|
||||
| `'example.com'`
|
||||
| Nom de domaine affiché (mentions légales…)
|
||||
|
||||
| `ORGANIZATION_SHORT_NAME`
|
||||
@@ -707,7 +707,7 @@ NOTE: Le cache de l'API PeerTube et de WordPress (`includes/simple-cache.php`) e
|
||||
[source,php]
|
||||
----
|
||||
<?php
|
||||
define('APP_HOST_NAME', 'annukuteced.buzz');
|
||||
define('APP_HOST_NAME', 'example.com');
|
||||
|
||||
// PeerTube (chaîne GADE du podcast)
|
||||
define('PEERTUBE_URL', 'https://gade.o-k-i.net');
|
||||
@@ -744,7 +744,7 @@ define('CACHE_DURATION', 3600);
|
||||
|
||||
==== Fichiers d'instance à personnaliser
|
||||
|
||||
Les fichiers `sitemap.xml`, `robots.txt`, `site.webmanifest`, `mentions-legales.php` et `dons.php` sont ignorés par Git : copiez les `.sample` puis adaptez-les. Les exemples fournis sont *pré-remplis pour `annukuteced.buzz`* ; pour un autre domaine, remplacez simplement les occurrences du domaine. Dans `mentions-legales.php`, remplacez aussi le placeholder `VOTRE-DATE-MAJ`.
|
||||
Les fichiers `sitemap.xml`, `robots.txt`, `site.webmanifest`, `mentions-legales.php` et `dons.php` sont ignorés par Git : copiez les `.sample` puis adaptez-les. Les exemples fournis utilisent le domaine générique `example.com` : remplacez-le par votre domaine réel. Dans `mentions-legales.php`, remplacez aussi le placeholder `VOTRE-DATE-MAJ`.
|
||||
|
||||
=== 🧭 Ordre des sections sur la page d'accueil
|
||||
|
||||
@@ -793,8 +793,8 @@ WARNING: Cette configuration est *essentielle* : sans elle, vos fichiers de conf
|
||||
[source,bash]
|
||||
----
|
||||
# Adaptez les chemins dans conf/nginx.conf.sample puis :
|
||||
sudo cp conf/nginx.conf.sample /etc/nginx/sites-available/annukuteced.buzz
|
||||
sudo ln -s /etc/nginx/sites-available/annukuteced.buzz /etc/nginx/sites-enabled/
|
||||
sudo cp conf/nginx.conf.sample /etc/nginx/sites-available/example.com
|
||||
sudo ln -s /etc/nginx/sites-available/example.com /etc/nginx/sites-enabled/
|
||||
sudo nginx -t && sudo systemctl reload nginx
|
||||
----
|
||||
|
||||
@@ -843,7 +843,7 @@ WARNING: Pour que la détection fonctionne, `sw.js` ne doit *pas* être caché l
|
||||
|
||||
==== Installation par les visiteurs
|
||||
|
||||
- 🌐 *Chrome/Edge* : menu → « Installer annukuteced.buzz »
|
||||
- 🌐 *Chrome/Edge* : menu → « Installer example.com »
|
||||
- 🍎 *Safari iOS* : Partager → « Ajouter à l'écran d'accueil »
|
||||
- 🦊 *Firefox Android* : menu → « Installer »
|
||||
|
||||
@@ -867,7 +867,7 @@ Données alors collectées (anonymes) : pages visitées, pays d'origine (IP non
|
||||
. 🔧 Permissions : `644` pour les fichiers, `755` pour les dossiers ; `cache/` accessible en écriture
|
||||
. 📄 Créez les fichiers d'instance depuis les `.sample` (config, manifest, robots, sitemap, mentions légales, dons)
|
||||
. 🛡️ Copiez `conf/.htaccess.sample` en `.htaccess` (Apache)
|
||||
. 🌐 Faites pointer le domaine `annukuteced.buzz` vers le dossier d'installation
|
||||
. 🌐 Faites pointer votre domaine (ex. `example.com`) vers le dossier d'installation
|
||||
. 🧪 Testez la PWA via les outils de développement du navigateur (onglet Application)
|
||||
|
||||
=== 👨💻 Développement et contribution
|
||||
@@ -946,8 +946,8 @@ This application is a *fork* of https://labola.o-k-i.net/ORGANISATION-KA-INTERNA
|
||||
| This fork's repository
|
||||
| `git@labola.o-k-i.net:cedric/annu-kute-ced.git`
|
||||
|
||||
| Production domain
|
||||
| https://annukuteced.buzz
|
||||
| Domain (example)
|
||||
| https://example.com
|
||||
|
||||
| Governance
|
||||
| Application maintained by OKI; fork carried by the repository owner *cedric* (Cédric Famibelle-Pronzola)
|
||||
@@ -1171,7 +1171,7 @@ cp dons.php.sample dons.php
|
||||
. 🛡️ Install the hardened server configuration from `conf/` (see <<en-securite,Security>>).
|
||||
. ✍️ Make the `cache/` directory writable by the web server (created automatically on the first API call).
|
||||
. 🔒 Make sure HTTPS is enabled (mandatory for the PWA).
|
||||
. 🌐 Point your domain (`annukuteced.buzz`) to the project root.
|
||||
. 🌐 Point your domain (e.g. `example.com`) to the project root.
|
||||
|
||||
[[en-configuration]]
|
||||
=== ⚙️ Configuration
|
||||
@@ -1212,7 +1212,7 @@ Default values from `includes/config.default.php`.
|
||||
| Constant | Default | Description
|
||||
|
||||
| `APP_HOST_NAME`
|
||||
| `'annukuteced.buzz'`
|
||||
| `'example.com'`
|
||||
| Displayed domain name (legal notice…)
|
||||
|
||||
| `ORGANIZATION_SHORT_NAME`
|
||||
@@ -1611,7 +1611,7 @@ NOTE: The PeerTube API and WordPress cache (`includes/simple-cache.php`) is *alw
|
||||
[source,php]
|
||||
----
|
||||
<?php
|
||||
define('APP_HOST_NAME', 'annukuteced.buzz');
|
||||
define('APP_HOST_NAME', 'example.com');
|
||||
|
||||
// PeerTube (the podcast's GADE channel)
|
||||
define('PEERTUBE_URL', 'https://gade.o-k-i.net');
|
||||
@@ -1648,7 +1648,7 @@ define('CACHE_DURATION', 3600);
|
||||
|
||||
==== Instance files to customize
|
||||
|
||||
The `sitemap.xml`, `robots.txt`, `site.webmanifest`, `mentions-legales.php` and `dons.php` files are Git-ignored: copy the `.sample` files then adapt them. The provided samples are *pre-filled for `annukuteced.buzz`*; for another domain, simply replace the domain occurrences. In `mentions-legales.php`, also replace the `VOTRE-DATE-MAJ` placeholder.
|
||||
The `sitemap.xml`, `robots.txt`, `site.webmanifest`, `mentions-legales.php` and `dons.php` files are Git-ignored: copy the `.sample` files then adapt them. The provided samples use the generic `example.com` domain: replace it with your real domain. In `mentions-legales.php`, also replace the `VOTRE-DATE-MAJ` placeholder.
|
||||
|
||||
=== 🧭 Homepage section order
|
||||
|
||||
@@ -1697,8 +1697,8 @@ WARNING: This configuration is *essential*: without it, your configuration files
|
||||
[source,bash]
|
||||
----
|
||||
# Adjust the paths in conf/nginx.conf.sample, then:
|
||||
sudo cp conf/nginx.conf.sample /etc/nginx/sites-available/annukuteced.buzz
|
||||
sudo ln -s /etc/nginx/sites-available/annukuteced.buzz /etc/nginx/sites-enabled/
|
||||
sudo cp conf/nginx.conf.sample /etc/nginx/sites-available/example.com
|
||||
sudo ln -s /etc/nginx/sites-available/example.com /etc/nginx/sites-enabled/
|
||||
sudo nginx -t && sudo systemctl reload nginx
|
||||
----
|
||||
|
||||
@@ -1747,7 +1747,7 @@ WARNING: For detection to work, `sw.js` must *not* be cached for long by the ser
|
||||
|
||||
==== Installation by visitors
|
||||
|
||||
- 🌐 *Chrome/Edge*: menu → "Install annukuteced.buzz"
|
||||
- 🌐 *Chrome/Edge*: menu → "Install example.com"
|
||||
- 🍎 *Safari iOS*: Share → "Add to Home Screen"
|
||||
- 🦊 *Firefox Android*: menu → "Install"
|
||||
|
||||
@@ -1771,7 +1771,7 @@ Data then collected (anonymous): visited pages, country of origin (IP not stored
|
||||
. 🔧 Permissions: `644` for files, `755` for directories; `cache/` must be writable
|
||||
. 📄 Create the instance files from the `.sample` files (config, manifest, robots, sitemap, legal notice, donations)
|
||||
. 🛡️ Copy `conf/.htaccess.sample` to `.htaccess` (Apache)
|
||||
. 🌐 Point the `annukuteced.buzz` domain to the installation directory
|
||||
. 🌐 Point your domain (e.g. `example.com`) to the installation directory
|
||||
. 🧪 Test the PWA via the browser developer tools (Application tab)
|
||||
|
||||
=== 👨💻 Development and contributing
|
||||
|
||||
Reference in New Issue
Block a user