# Bookstack

# Installation bookstack

installation avec docker : suivre le tuto du site

Commentaires

- Difficulté pour l’accéder en réseau, et sans avoir un nom de domaine qui permette la certification
- Difficulté pour gérer les mails (envoi de mail sur événement)

<header class="single-post-header" id="bkmrk-installer-bookstack-"># Installer BookStack avec Docker

<div class="post-meta text-s"><span class="post-author"><svg></svg>[zarev](https://belginux.com/author/zarev/)</span><time class="post-date" datetime="2024-03-03"><svg></svg>3 mars 2024</time><span class="read-time"><svg></svg>6 min de lecture</span></div></header>### Table des matières

<div class="toc-container" id="bkmrk-%E2%9A%A1caract%C3%A9ristiques-l%27"><div class="toc js-toc">1. [⚡Caractéristiques](https://belginux.com/installer-bookstack-avec-docker/#%E2%9A%A1caract%C3%A9ristiques)
2. [L'installation](https://belginux.com/installer-bookstack-avec-docker/#linstallation)
    1. [Configurer le serveur mail](https://belginux.com/installer-bookstack-avec-docker/#configurer-le-serveur-mail)
3. [Compte admin](https://belginux.com/installer-bookstack-avec-docker/#compte-admin)
4. [Changer la langue](https://belginux.com/installer-bookstack-avec-docker/#changer-la-langue)
5. [Changer le Nom et l'E-mail du profil](https://belginux.com/installer-bookstack-avec-docker/#changer-le-nom-et-le-mail-du-profil)
6. [Changer le mot de passe](https://belginux.com/installer-bookstack-avec-docker/#changer-le-mot-de-passe)
7. [Activer le mode sombre](https://belginux.com/installer-bookstack-avec-docker/#activer-le-mode-sombre)

</div></div>> Merci à **DRjekyll49** &amp; **Biinocle** pour m'avoir averti du changement dans le compose!

BookStack est une plateforme simple, auto-hébergée et facile à utiliser pour organiser et stocker des informations sous forme de wiki.

### ⚡Caractéristiques

<div class="single-post-content" id="bkmrk-gratuit-et-open-sour">- Gratuit et open source: BookStack est entièrement gratuit et ouvert, sous licence MIT. La source est disponible sur GitHub. Il n'y a aucun frais pour télécharger et installer votre propre instance de bookstack.
- Interface simple et facile: la simplicité a été la priorité absolue lors de la création de BookStack. L'éditeur de page possède une interface WYSIWYG simple et tout le contenu est divisé en trois groupes simples =&gt; Livres, Chapitres, Pages.
- Consultable et connecté: le contenu de BookStack est entièrement consultable. Vous pouvez effectuer une recherche au niveau du livre ou dans tous les livres, chapitres et pages. La possibilité de créer un lien direct vers n’importe quel paragraphe vous permet de garder votre documentation connectée.
- Configurable: les options de configuration vous permettent de configurer BookStack en fonction de votre cas d'utilisation. Vous pouvez modifier le nom, le logo et les options d'enregistrement. Vous pouvez également modifier si l'ensemble du système est visible publiquement ou non.
- Exigences simples: BookStack est construit en utilisant PHP, au-dessus du framework Laravel et utilise MySQL pour stocker les données. Les performances ont été gardées à l'esprit et BookStack peut fonctionner sans problème sur un simple VPS.
- L'éditeur de pages de BookStack intègre la capacité de dessin de [https://app.diagrams.net](https://app.diagrams.net/?ref=belginux.com), permettant la création rapide et facile de diagrammes dans votre documentation.
- Multilingue: les utilisateurs de BookStack peuvent définir leur langue préférée. Grâce aux excellents contributeurs de la communauté, les langues actuelles intégrées à BookStack incluent EN, FR, DE, ES, IT, JA, NL, PL, RU et bien d'autres.
- Éditeur de démarques facultatif: si vous préférez écrire en Markdown alors BookStack vous soutient. Un éditeur de démarques est fourni et inclut un aperçu en direct pendant que vous rédigez votre documentation.
- Authentification intégrée: en plus de la connexion par e-mail/mot de passe par défaut, des fournisseurs sociaux tels que GitHub, Google, Slack, AzureAD et bien d'autres peuvent être utilisés. Les options Okta, SAML2 et LDAP sont disponibles pour les environnements d'entreprise.
- Fonctionnalités puissantes: en plus de la recherche et des liens puissants, il existe également un tri croisé entre les livres, des révisions de pages et une gestion des images. Un système complet de rôles et d'autorisations vous permet de verrouiller le contenu et les actions selon vos besoins.
- Authentification multifacteur: MFA est intégré et peut être appliqué au niveau de chaque rôle, si vous le souhaitez. Les options MFA incluent TOTP (Google/Microsoft Authenticator, Authy, etc...) et des codes de sauvegarde statiques.
- Modes sombre et clair: BookStack propose son interface utilisateur à la fois dans un thème clair et dans un thème sombre, sauvant ainsi les yeux de ceux qui préfèrent travailler dans l'ombre. Ceci est configurable au niveau de l'utilisateur.

<figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/bookstack-hero-screenshot.webp)</figure></div>Si vous avez la moindre difficulté, n'oubliez pas que vous pouvez rejoindre belginux sur [Discord et Matrix](https://belginux.com/contactez-moi/)!

<div class="single-post-content" id="bkmrk-">---

</div>## L'installation

<div class="single-post-content" id="bkmrk-il-faut-commencer-pa">1. Il faut commencer par générer une clé avec la commande suivante:

<div class="code-toolbar"></div></div>```code
docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey
```

<div class="single-post-content" id="bkmrk-copy"><div class="code-toolbar"><div class="toolbar"><div class="toolbar-item"><button class="copy-to-clipboard-button" data-copy-state="copy" type="button">Copy</button></div></div></div></div>Ce qui retourne:

<div class="single-post-content" id="bkmrk--1"><figure class="kg-card kg-image-card">![](https://belginux.com/content/images/2024/11/Screenshot_20241108_151002.png)</figure></div>Copiez toute la clé, base64: compris, et mettez cette clé de côté.

<div class="single-post-content" id="bkmrk-cr%C3%A9ez-votre-docker-c">2. Créez votre docker-compose.yml:

<div class="code-toolbar"></div></div>```code
sudo nano docker-compose.yml
```

<div class="single-post-content" id="bkmrk-copy-collez-%C3%A7a-dedan"><div class="code-toolbar"><div class="toolbar"><div class="toolbar-item"><button class="copy-to-clipboard-button" data-copy-state="copy" type="button">Copy</button></div></div></div>3. Collez ça dedans en prenant soin d'adapter le port et les volumes suivant votre configuration:

<div class="code-toolbar"></div></div>```yaml
version: "2"
services:
  bookstack:
    image: lscr.io/linuxserver/bookstack:latest
    container_name: bookstack
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - APP_KEY=base64:mhoEccThD5nT/94EWcFnWQV6E8XNeNVca75J7neYz6s=
      - APP_URL=http://192.168.1.152:6875
      - DB_HOST=bookstack_db
      - DB_PORT=3306
      - DB_USERNAME=bookstack
      - DB_PASSWORD=VotreMotDePasse
      - DB_DATABASE=bookstackapp
      - APP_DEFAULT_DARK_MODE=true
      #- MAIL_DRIVER=smtp
      #- MAIL_HOST=smtp.gmail.com
      #- MAIL_PORT=465
      #- MAIL_ENCRYPTION=tls
      #- MAIL_USERNAME=yourEMAIL
      #- MAIL_PASSWORD=yourPassword
      #- MAIL_FROM=yourEMAIL
      #- MAIL_FROM_NAME=yourNAME
    volumes:
      - ./config:/config
    ports:
      - 6875:80
    restart: unless-stopped
  bookstack_db:
    image: lscr.io/linuxserver/mariadb:latest
    container_name: maria_db
    ports:
      - 3308:3306 # 3308 is a DB port visible on HOST
    environment:
      - PUID=1000
      - PGID=1000
      - MYSQL_ROOT_PASSWORD=VotreMotDePasseBis
      - MYSQL_DATABASE=bookstackapp
      - MYSQL_USER=bookstack
      - MYSQL_PASSWORD=VotreMotDePasse
    volumes:
      - ./db/config:/config
    restart: unless-stopped
```

<div class="single-post-content" id="bkmrk-copy-1"><div class="code-toolbar"><div class="toolbar"><div class="toolbar-item"><button class="copy-to-clipboard-button" data-copy-state="copy" type="button">Copy</button></div></div></div></div>Veillez à compléter les éléments suivants:

<div class="single-post-content" id="bkmrk-%C2%A0--app_key%3D%C2%A0%3D%3E-indiq">- [ ]  **- APP\_KEY=** =&gt; Indiquez la clé complète générée au début du tutoriel.

- [ ]  **- APP\_URL=http://192.168.1.152:6875** =&gt; soit vous indiquez votre IP locale + port ou votre nom de domaine, https.ndd.tld.

- [ ]  **- DB\_PASS=VotreMotDePasse** =&gt; choisissez un mot de passe fort.

- [ ]  **- MYSQL\_ROOT\_PASSWORD=VotreMotDePasseBis** =&gt; choisissez un mot de passe fort différent de VotreMotDePasse.

- [ ]  **- TZ=Europe/Brussels** =&gt; adaptez suivant votre localisation.

- [ ]  **- MYSQL\_PASSWORD=VotreMotDePasse** =&gt; choisissez un mot de passe fort.

- [ ]  **\#- APP\_DEFAULT\_DARK\_MODE=true** =&gt; décommentez, donc retirez le signe # si vous voulez que le mode sombre soit activé par défaut.

</div>### Configurer le serveur mail

Si vous voulez activer le serveur mail (dans cet exemple, Gmail, adaptez selon le fournisseur), il faut décommenter, donc retirez le signe **\#** de toutes les lignes concernant le serveur mail et compléter comme ceci:

<div class="single-post-content" id="bkmrk-%C2%A0mail_driver%3Dsmtp-%C2%A0m">- [ ]  **MAIL\_DRIVER=smtp**

- [ ]  **MAIL\_HOST=smtp.gmail.com**

- [ ]  **MAIL\_PORT=465**

- [ ]  **MAIL\_ENCRYPTION=tls**

- [ ]  **MAIL\_USERNAME=yourEMAIL** =&gt; remplacer yourEMAIL par votre Gmail.

- [ ]  **MAIL\_PASSWORD=yourPassword** =&gt; remplacer yourPassword par le mot de passe créé, lire l'encadré ci-dessous.

- [ ]  **MAIL\_FROM=yourEMAIL** =&gt; remplacer yourEMAIL par votre Gmail.

- [ ]  **MAIL\_FROM\_NAME=yourNAME** =&gt; remplacer yourNAME par votre nom.

<div class="kg-card kg-callout-card kg-callout-card-blue"><div class="kg-callout-emoji">💡</div><div class="kg-callout-text">Pour le mot de passe, avec Gmail c'est terminé de mettre son vrai mot de passe dans une application tierce. Ils ont mis en place un système pour créer un mot de passe différent pour une application tierce.  
[Je l'explique ici](https://belginux.com/nextcloud-configurer-le-serveur-de-messagerie/), à partir de **Activez la double authentification sur votre compte Gmail** jusqu'à **Copiez et conservez bien votre mot de passe, validez ensuite avec OK**.  
Quand vous avez le mot de passe dédié, mettez-le dans le formulaire.</div></div>4. On va déployer l'application:

<div class="code-toolbar"></div></div>```code
docker-compose up -d

```

<div class="single-post-content" id="bkmrk-copy-2"><div class="code-toolbar"><div class="toolbar"><div class="toolbar-item"><button class="copy-to-clipboard-button" data-copy-state="copy" type="button">Copy</button></div></div></div></div>ou avec docker-compose V2:

```code
docker compose up -d
```

<div class="single-post-content" id="bkmrk-copy-%F0%9F%92%A1-cela-peut-pre"><div class="code-toolbar"><div class="toolbar"><div class="toolbar-item"><button class="copy-to-clipboard-button" data-copy-state="copy" type="button">Copy</button></div></div></div><div class="kg-card kg-callout-card kg-callout-card-blue"><div class="kg-callout-emoji">💡</div><div class="kg-callout-text">Cela peut prendre un peu de temps avoir que tout soit bien déployé, soyez patient.</div></div>5. Rendez-vous sur l'ip:port, suivant l'IP de votre serveur local et du port choisi, 6875 par défaut:

<div class="code-toolbar"></div></div>```code
http://ip:6875/
```

<div class="single-post-content" id="bkmrk-copy-3"><div class="code-toolbar"><div class="toolbar"><div class="toolbar-item"><button class="copy-to-clipboard-button" data-copy-state="copy" type="button">Copy</button></div></div></div></div>Ou votre domaine:

```code
https://bookstack.mondomaine.com
```

<div class="single-post-content" id="bkmrk-copy-4"><div class="code-toolbar"><div class="toolbar"><div class="toolbar-item"><button class="copy-to-clipboard-button" data-copy-state="copy" type="button">Copy</button></div></div></div>---

</div>## Compte admin

Lors du premier lancement il faudra indiquer le compte administrateur par défaut:

<div class="single-post-content" id="bkmrk-e-mail%C2%A0%3D%3E-admin%40admi">- **E-mail** =&gt; admin@admin.com
- **Mot de passe** =&gt; password

</div>Validez en cliquant sur **Se Connecter**:

<div class="single-post-content" id="bkmrk--2"><figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/Screenshot_20240302_162311.png)</figure></div>Bienvenue sur la page principale de BookStack:

<div class="single-post-content" id="bkmrk--3"><figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/Screenshot_20240302_162652.png)</figure>---

</div>## Changer la langue

Allez en haut à droite, cliquez sur **Admin**, ensuite sur **My Account**:

<div class="single-post-content" id="bkmrk--4"><figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/Screenshot_20240302_162858.png)</figure></div>Dans **Preferred Language**, sélectionnez la langue de votre choix, ici le français, validez avec **Save**:

<div class="single-post-content" id="bkmrk--5"><figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/Screenshot_20240302_162944.png)</figure></div>BookStack est désormais en français:

<div class="single-post-content" id="bkmrk--6"><figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/Screenshot_20240302_163049.png)</figure>---

</div>## Changer le Nom et l'E-mail du profil

Allez en haut à droite, cliquez sur **Admin**, ensuite sur M**on compte**:

<div class="single-post-content" id="bkmrk--7"><figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/Screenshot_20240302_163313.png)</figure></div>Changez **Nom** et **E-mail** avec les informations souhaitées, validez avec **Enregistrer**:

<div class="single-post-content" id="bkmrk--8"><figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/Screenshot_20240302_163401.png)</figure>---

</div>## Changer le mot de passe

Allez en haut à droite, cliquez sur **Admin**, ensuite sur M**on compte**:

<div class="single-post-content" id="bkmrk--9"><figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/Screenshot_20240302_163313.png)</figure></div>Dans le menu de gauche, sélectionnez **Accès et sécurité**, remplissez les deux champs du mot de passe et validez en cliquant sur **Modifier**:

<div class="single-post-content" id="bkmrk--10"><figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/Screenshot_20240302_163700.png)</figure>---

</div>## Activer le mode sombre

Tout simplement sur la page principale:

<div class="single-post-content" id="bkmrk--11"><figure class="kg-card kg-image-card kg-width-wide">![](https://belginux.com/content/images/2024/03/Screenshot_20240302_165151.png)</figure></div>

# Backuping and restoring

[https://www.bookstackapp.com/docs/admin/backup-restore/](https://www.bookstackapp.com/docs/admin/backup-restore/)

# Backup and Restore

While BookStack does not currently have a built-in way to backup and restore content, it can usually be done via the command line with relative ease. The below commands are based on using Ubuntu. If you are using a different operating system you may have to alter these commands to suit.

---

### Backup

There are two types of content you need to backup: Files and database records.

#### Database

The easiest way to backup the database is via `mysqldump`:

<div class="highlight" id="bkmrk-1-2-3-4-5-6-7-%23-synt"><div class="chroma"><table class="lntable"><tbody><tr><td class="lntd">```
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-0-1">1</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-0-2">2</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-0-3">3</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-0-4">4</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-0-5">5</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-0-6">6</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-0-7">7</a>

```

</td><td class="lntd">```bash
# Syntax
## Only specify the `-p` option if the user provided has a password
mysqldump -u {mysql_user} -p {database_name} > {output_file_name}


# Example
mysqldump -u benny bookstack > bookstack.backup.sql

```

</td></tr></tbody></table>

</div></div>If you are using MySQL on Ubuntu, and are using the `root` MySQL user, you will likely have to run the command above with `sudo`:

<div class="highlight" id="bkmrk-1-sudo-mysqldump--u-"><div class="chroma"><table class="lntable"><tbody><tr><td class="lntd">```
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-1-1">1</a>

```

</td><td class="lntd">```bash
sudo mysqldump -u root bookstack > bookstack.backup.sql

```

</td></tr></tbody></table>

</div></div>The resulting file (`bookstack.backup.sql` in the examples above) will contain all the data from the database you specified. Copy this file to somewhere safe, ideally on a different device.

#### Files

Below is a list of files and folders containing data you should back up. The paths are shown relative to the root BookStack folder.

- `.env` - File, contains important configuration information.
- `public/uploads` - Folder, contains any uploaded images.
- `storage/uploads` - Folder, contains uploaded page attachments.
- `themes` - Folder, contains any configured [visual/logical themes](https://www.bookstackapp.com/docs/admin/hacking-bookstack/#visual-theme-system).

Alternatively you could backup up your whole BookStack folder but only the above contain important instance-specific data by default.

The following command will create a compressed archive of the above folders and files:

<div class="highlight" id="bkmrk-1-tar--czvf-bookstac"><div class="chroma"><table class="lntable"><tbody><tr><td class="lntd">```
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-2-1">1</a>

```

</td><td class="lntd">```bash
tar -czvf bookstack-files-backup.tar.gz .env public/uploads storage/uploads themes

```

</td></tr></tbody></table>

</div></div>The resulting file (`bookstack-files-backup.tar.gz`) will contain all your file data. Copy this to a safe place, ideally on a different device.

---

### Restore

If you are restoring from scratch follow the [installation](https://www.bookstackapp.com/docs/admin/installation) instructions first to get a new BookStack instance set-up but **do not run the `php artisan migrate` installation step when installing BookStack**. You may need to comment this command out if using an installer script.

If you are using a docker-container-based set-up, restore the database before running the BookStack container. An example of the process using a linuxserver.io-based docker-compose setup can be seen [in our video here](https://youtu.be/6A8hLuQTkKQ?t=1050).

#### Database

To restore the database you simply need to execute the sql in the output file from the `mysqldump` you performed above. To do this copy your database SQL backup file onto the BookStack or database host machine and run the following:

<div class="highlight" id="bkmrk-1-2-3-4-5-6-7-8-9-10"><div class="chroma"><table class="lntable"><tbody><tr><td class="lntd">```
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-3-1"> 1</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-3-2"> 2</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-3-3"> 3</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-3-4"> 4</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-3-5"> 5</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-3-6"> 6</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-3-7"> 7</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-3-8"> 8</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-3-9"> 9</a>
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-3-10">10</a>

```

</td><td class="lntd">```bash
# Syntax
mysql -u {mysql_user} -p {database_name} < {backup_file_name}
## Only specify the -p if the user provided has a password

# Example
mysql -u benny -p bookstack < bookstack.backup.sql

# If using the root user on Ubuntu you may
# have to run the above with root permissions via sudo:
sudo mysql -u root bookstack < bookstack.backup.sql

```

</td></tr></tbody></table>

</div></div>If you are restoring to a new version of BookStack you will have to run `php artisan migrate` after restore to perform any required updates to the database.

#### Files

To restore the files you simply need to copy them from the backup archive back to their original locations. If you created a compressed `bookstack-files-backup.tar.gz` archive as per the backup instructions above you can simply copy that file to your BookStack folder then run the following command:

<div class="highlight" id="bkmrk-1-tar--xvzf-bookstac"><div class="chroma"><table class="lntable"><tbody><tr><td class="lntd">```
<a href="https://www.bookstackapp.com/docs/admin/backup-restore/#hl-4-1">1</a>

```

</td><td class="lntd">```bash
tar -xvzf bookstack-files-backup.tar.gz

```

</td></tr></tbody></table>

</div></div>If you get errors during the above command it may be due to permissions. Change permissions so you can write to the restore locations.

After a backup of the files you should reset the permissions to ensure any write-required locations are writable by the server. The locations required for this can be found in the [installation instructions](https://www.bookstackapp.com/docs/admin/installation).

#### Configuration (.env File)

During a restore, you may end up merging various configuration options between your old and new instance `.env` files, to get things working for the new environment. For example, it’s common to use the old `.env` settings for most things but use database settings from the `.env` file of a newly created instance.

One thing to be aware of is that you should use the `APP_KEY` value of the old `.env` file since this is used for various features like the encryption of multi-factor authentication credentials. Changing the `APP_KEY` may cause such features to break.

#### URL Changes

If you are restoring into an environment where BookStack will run on a different URL, there are a couple of things you’ll need to do after restoring everything:

- Within the `.env` config file update the `APP_URL` value to exactly match your new base URL.
- Run the [“Update System URL” command](https://www.bookstackapp.com/docs/admin/commands/#update-system-url) to update your database content to use your new URL.

If you migrated web-server configuration files, you may also need to tweak those to correctly use the new URL.

# Astuces et amélioration

stats page vue :

[https://github.com/BookStackApp/BookStack/issues/4775#issuecomment-2474510624](https://github.com/BookStackApp/BookStack/issues/4775#issuecomment-2474510624)

une solution extérieur :

[https://www.bookstackapp.com/blog/replacing-ga-and-mailchim7p/](https://www.bookstackapp.com/blog/replacing-ga-and-mailchimp/)

# sys commande pour gérer boostack

<table border="1" id="bkmrk-usage-commande-entre" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 36.3691%;"></col><col style="width: 63.7501%;"></col></colgroup><tbody><tr><td>usage</td><td>commande</td></tr><tr><td>Entrer dans la base de données du conatainer</td><td>sdockexecroot seg\_mariadb mariadb --user=&lt;mariadb-username&gt; --password=&lt;mariadb-usr-pwd&gt;</td></tr><tr><td>  
</td><td>  
</td></tr></tbody></table>

# Structure base et dev

Tables :

MariaDB \[bookstack\]&gt; show tables;  
+------------------------+  
| Tables\_in\_bookstack |  
+------------------------+  
| activities |  
| api\_tokens |  
| attachments |  
| books |  
| bookshelves |  
| bookshelves\_books |  
| cache |  
| chapters |  
| comments |  
| deletions |  
| email\_confirmations |  
| entity\_permissions |  
| failed\_jobs |  
| favourites |  
| images |  
| imports |  
| jobs |  
| joint\_permissions |  
| mfa\_values |  
| migrations |  
| page\_revisions |  
| pages |  
| password\_resets |  
| permission\_role |  
| references |  
| role\_permissions |  
| role\_user |  
| roles |  
| search\_terms |  
| sessions |  
| settings |  
| social\_accounts |  
| sort\_rules |  
| tags |  
| user\_invites |  
| users |  
| views |  
| watches |  
| webhook\_tracked\_events |  
| webhooks |  
+------------------------+

# Hacks : notify-page-updates-for-tagged-books

essai 27 bookstack-module.json

dans  
nicolas@msi-01:/srv/bookstack$ nano docker-compose .yml

image: linuxserver/bookstack:26.03.20260315

##### Puis :

dans le .env !

nicolas@msi-01:/srv/bookstack$ sdock compose down &amp;&amp; sdock compose up -d  
nicolas@msi-01:/srv/bookstack$ sdockexec &lt;container\_name&gt; bash

root@597eaf963fbf:/# apk update &amp;&amp; apk add --no-cache php85-cli php85-mbstring php85-xml php85-zip  
<span style="white-space: pre-wrap;">root@597eaf963fbf:/# wget </span>[https://www.bookstackapp.com/hack-modules/notify-tagged-page-updates.zip](https://www.bookstackapp.com/hack-modules/notify-tagged-page-updates.zip)  
root@597eaf963fbf:/# mv notify-tagged-page-updates.zip /app/www/  
root@597eaf963fbf:/# cd /app/www/ &amp;&amp; php artisan bookstack:install-module notify-tagged-page-updates.zip  
root@597eaf963fbf:/# apk add nano  
root@597eaf963fbf:/# nano /app/www/themes/custom/modules/notify-page-updates-for-tagged-books/functions.php

Modif dans la fonction ;

> 24 public function toMail(User $notifiable): MailMessage  
> 25 {  
> 26 /\*\* @var Page $page \*/  
> 27 $page = $this-&gt;detail;  
> 28 $updater = $this-&gt;user;  
> 29  
> 30 return (new MailMessage())  
> 31 // -&gt;subject('BookStack page update notification')  
> 32 // -&gt;line("La page \\"{$page-&gt;name}\\" has been updated by \\"{$updater-&gt;name}\\"")  
> 33 -&gt;subject('BookStack : notification de mise à jour de page')  
> 34 -&gt;line("The page \\"{$page-&gt;name}\\" a été mise à jour par \\"{$updater-&gt;name}\\"")  
> 35 -&gt;action('View Page', $page-&gt;getUrl());  
> 36 }

root@597eaf963fbf:/# exit

puis :

nicolas@msi-01:/srv/bookstack$ sdock retart &lt;nom\_container&gt;

ATTENTION :

NOM DU TAG : notify en minuscule  
Rôles à pousser : casse identique au nom du rôle, plusieurs rôles séparés par une virgule.

Etat courant :

## Thème BookStack custom

### Modules installés

#### notify-page-updates-for-tagged-books

- Source : https://www.bookstackapp.com/hacks/notify-tagged-page-updates/
- Installé le : 2026-03-17
- Testé sur : v26.03

**Fonctionnement :**<span style="white-space: pre-wrap;"> Envoie un mail aux utilisateurs des rôles listés dans un tag </span>`<span class="editor-theme-code">notify</span>`<span style="white-space: pre-wrap;"> (séparateur virgule) appliqué au </span>**livre**<span style="white-space: pre-wrap;"> (pas au chapitre ni à la page).</span>

**Exemple de tag sur le livre :**

- <span style="white-space: pre-wrap;">Nom : </span>`<span class="editor-theme-code">notify</span>`
- <span style="white-space: pre-wrap;">Valeur : </span>`<span class="editor-theme-code">mn-et-nf,Admin</span>`

**Modifications apportées au functions.php original :**

- Textes des mails traduits en français
- Logs de debug ajoutés (niveau debug, silencieux en prod)

nouvelle fonction avec 1 mail tous les xxx

**Ce qui a changé par rapport à ton fichier actuel :**

- <span style="white-space: pre-wrap;">Constante </span>`<span class="editor-theme-code">NOTIFY_COOLDOWN_HOURS = 4</span>`<span style="white-space: pre-wrap;"> en haut du fichier — </span>**un seul endroit à modifier**<span style="white-space: pre-wrap;"> pour changer la fréquence</span>
- <span style="white-space: pre-wrap;">Le cooldown est vérifié </span>**avant**<span style="white-space: pre-wrap;"> toute requête SQL — si actif, on sort immédiatement sans toucher la base</span>
- <span style="white-space: pre-wrap;">Le cooldown est armé </span>**après**<span style="white-space: pre-wrap;"> l'envoi réussi des mails — si une erreur survient avant, le prochain enregistrement retente</span>
- <span style="white-space: pre-wrap;">Tous les </span>`<span class="editor-theme-code">\Log::info</span>`<span style="white-space: pre-wrap;"> remplacés par </span>`<span class="editor-theme-code">\Log::debug</span>`<span style="white-space: pre-wrap;"> — silencieux en prod, visibles si </span>`<span class="editor-theme-code">LOG_LEVEL=debug</span>`
- Message du mail entièrement en français

# Écriture d'une nouvelle fonctionnalité : s'abonner aux notification de pages modifiées dans un livre.

---

## Plan d'action — Digest de suivi de livres BookStack

### Contexte

Remplacer le hack `notify-tagged-page-updates` (notification par rôle, immédiate) par un système de **suivi individuel par utilisateur** avec **digest périodique**.

---

### Ce qu'on sait déjà

- ❌ Pas d'événement `CRON/DAILY` dans `ThemeEvents.php` → le déclencheur du digest sera un **cron sur l'hôte** (`msi-01`)
- ✅ Le stockage sera un **fichier JSON externe** monté en volume, jamais touché par les mises à jour de l'image
- ✅ L'abonnement se fait via un **tag `follow:nicolas,marino`** posé manuellement sur le livre — choix individuel, pas de groupe

<p class="callout warning">Pas totalement d'accord avec le cron externe : cela fragilise le système. au moins une cron intégré au conteneur serait plus sécurisé. mais utiliser la fonction schedule de laravel serait le plus robuste.</p>

---

### Les 3 chantiers

**Chantier 1 — Le fichier JSON**

- Définir son emplacement dans le volume (`/srv/bookstack/bookstack_data/hack-digest.json`)
- Définir sa structure définitive
- Le créer vide au départ

**Chantier 2 — Réécriture du `functions.php`**

- Écouter `PAGE_UPDATE` → lire le tag `follow:` sur le livre → accumuler dans le JSON
- Remplacer toute la logique d'envoi immédiat par l'accumulation

**Chantier 3 — Le digest**

- Écrire le script d'envoi (commande artisan custom ou script PHP standalone)
- Formater l'email récapitulatif (liste des pages modifiées par livre)
- Brancher le cron sur l'hôte à l'heure souhaitée

---

### Questions à trancher en début de prochaine session

1. **Fréquence du digest** — quotidien à heure fixe ? Paramétrable par utilisateur ?
2. **Emplacement du JSON** — à confirmer selon la structure de tes volumes
3. **Format de l'email** — simple liste texte ou HTML avec liens cliquables ?

---

Bonne soirée ! 🚀