Unraid | AlexIn Tech

Selfhoster / héberger AFFiNE sur Unraid en utilisant docker

Fri, 08 Mar 2024 00:00:00 +0000

Selfhoster / héberger AFFiNE sur Unraid en utilisant docker

Hello ! Il y a quelques semaines j’avais publié un post qui expliquait comment héberger Monica sur Unraid en utilisant docker-compose.

Je pars donc du principe vous avez déjà installé le plugin “Docker Compose” sur votre serveur Unraid et que vous savez l’utiliser. Si ce n’est pas le cas, je vous redirige vers mon article sur l’installation de Monica.

Aujourd’hui je vais vous partager rapidement comment selfhoster / héberger AFFiNE sur Unraid en utilisant docker.

Mais premièrement, qu’est-ce que AFFiNE ?

D’après leur page GitHub, AFFiNE est une sorte de croisement entre Notion et Miro, offrant une plateforme tout-en-un open source conçue pour fusionner écriture, dessin, et planification dans un espace de travail hyper-fusionné, orienté vers la confidentialité et le local-first. Avec sa toile sans limites pour tout type de blocs — texte enrichi, notes, pages web intégrées, et bien plus. AFFiNE se positionne comme la solution ultime pour les esprits créatifs. La plateforme supporte la collaboration en temps réel, offre la possibilité de se gérer et s’héberger soi-même, et prépare l’arrivée d’une communauté de plugins pour une personnalisation poussée. AFFiNE est l’outil parfait pour ceux qui cherchent à repousser les frontières de leur productivité et créativité.

⚠️ Disclaimer : C’est eux qui le disent hein, pas moi. J’ai juste tenté de rassembler les infos et de les traduire en FR.

En gros, tu prends Notion, tu prends Miro, et tu les fusionnes. Voilà ça c’est moi qui le dit.

Installer AFFiNE

Alors on rentre dans le vif du sujet, pour installer AFFiNE j’ai modifié un tout petit peu leur fichier compose.yaml qui est dispo sur leur github .

Voici donc ma version et j’y ai annoté quelques commentaires afin que vous puissiez le compléter plus facilement de votre côté.

🆕 Afin de copier/coller/télécharger plus facilement ce code, j’ai créé un repository dédié aux ressources de mon blog sur github. Voici le lien du fichier docker-compose.yml de cet article :

https://github.com/AlexIn-Tech/alexin.tech_blog_ressources/blob/main/Docker/AFFiNE/docker-compose.yml

services:
 affine:
 image: ghcr.io/toeverything/affine-graphql:stable
 container_name: affine_selfhosted
 command:
 ['sh', '-c', 'node ./scripts/self-host-predeploy && node ./dist/index.js']
 ports:
 # CHANGE YOUR PORTS HERE IF NEEDED PORT:PORT_INSIDE_CONTAINER
 - '3010:3010'
 - '5555:5555'
 depends_on:
 redis:
 condition: service_healthy
 postgres:
 condition: service_healthy
 volumes:
 # CHANGE YOUR PATH HERE FOR the custom configuration
 - /mnt/user/appdata/affine-app:/root/.affine/config
 # CHANGE YOUR PATH HERE FOR blob storage
 - /mnt/user/appdata/affine-app:/root/.affine/storage
 logging:
 driver: 'json-file'
 options:
 max-size: '1000m'
 restart: unless-stopped
 environment:
 - NODE_OPTIONS="--import=./scripts/register.js"
 - AFFINE_CONFIG_PATH=/root/.affine/config
 - REDIS_SERVER_HOST=redis
 # REPLACE MY_DB_PWD_TOP_SECRET BY YOUR PWD
 - DATABASE_URL=postgres://affine:MY_DB_PWD_TOP_SECRET@postgres:5432/affine
 - NODE_ENV=production
 # REPLACE YOUR_EMAIL BY YOUR EMAIL
 - AFFINE_ADMIN_EMAIL=YOUR_EMAIL
 # REPLACE YOUR_PWD BY YOUR PWD
 - AFFINE_ADMIN_PASSWORD=YOUR_PWD
 redis:
 image: redis
 container_name: affine_redis
 restart: unless-stopped
 volumes:
 # CHANGE YOUR PATH HERE
 - /mnt/user/appdata/affine-redis:/data
 healthcheck:
 test: ['CMD', 'redis-cli', '--raw', 'incr', 'ping']
 interval: 10s
 timeout: 5s
 retries: 5
 postgres:
 image: postgres
 container_name: affine_postgres
 restart: unless-stopped
 volumes:
 # CHANGE YOUR PATH HERE
 - /mnt/user/appdata/affine-db:/var/lib/postgresql/data
 healthcheck:
 test: ['CMD-SHELL', 'pg_isready -U affine']
 interval: 10s
 timeout: 5s
 retries: 5
 environment:
 POSTGRES_USER: affine
 # REPLACE MY_DB_PWD_TOP_SECRET BY YOUR PWD
 POSTGRES_PASSWORD: MY_DB_PWD_TOP_SECRET
 POSTGRES_DB: affine
 PGDATA: /var/lib/postgresql/data/pgdata

Bien entendu tu peux aussi faire d’autres changements si tu le souhaites, comme p.ex modifier le nom d’utilisateur postgres ou ce genre de choses.

Pour l’installation rien de plus simple => Unraid > Docker > New Stack > Edit Stack > On y ajoute le contenu de notre fichier compose.yaml et le tour est joué => Compose Up , et ça tourne !

Config dans l’app

Comme mentionné dans la documentation officielle, n’oubliez pas de vous logguer avec vos identifient puis de synchroniser votre workspace avec le “cloud”. Par cloud ils entendent “votre propre serveur” vu qu’on est en selfhost.

Ce sont les identifiants que vous avez spécifier dans le fichier compose.yaml

Une fois loggué il ne vous restera plus qu’à synchroniser le workspace avec “le cloud” (qui est en fait votre propre serveur) .

Voilà , Enjoy ! 😎

AlexIn Tech

Monica PRM n'envoie pas les rappels par e-mail - Comment résoudre ce problème

Sun, 04 Feb 2024 00:00:00 +0000

Monica PRM n’envoie pas les rappels par e-mail - Comment résoudre ce problème

Dans une mise à jour récente de mon guide sur l’installation de Monica en utilisant Docker sur Unraid, quelques utilisateurs ont signalé avoir rencontré un problème où les rappels par e-mail n’étaient pas envoyés et j’ai également eu le même problème. Ce problème, suivi sur le GitHub de Monica sous le numéro #4178, a une solution simple que je vais partager avec vous aujourd’hui.

L’essentiel de la solution implique d’exécuter la tâche cron dans un conteneur Docker dédié. Ci-dessous, j’ai partagé les configurations des fichiers Docker-compose et .env que j’utilise sur mon serveur Unraid. Cette architecture résout le problème, assurant que vMonica envoie les rappels par e-mail comme prévu.

Docker-compose File

🆕 Afin de copier/coller/télécharger plus facilement ce code, j’ai créé un repository dédié aux ressources de mon blog sur github. Voici le lien des fichiers docker-compose.yml et .env de cet article :

https://github.com/AlexIn-Tech/alexin.tech_blog_ressources/tree/main/Docker/Monica

Voici le fichier docker-compose.yml :

version: "3.9"

services:
 app:
 image: monica
 env_file: .env
 depends_on:
 - db
 ports:
 - 8181:80
 volumes:
 - /mnt/user/appdata/monica-webapp:/var/www/html/storage
 restart: always

 cron:
 image: monica
 env_file: .env
 restart: always
 volumes:
 - /mnt/user/appdata/monica-webapp:/var/www/html/storage
 command: cron.sh
 depends_on:
 - db

 db:
 image: mariadb:11
 environment:
 - MYSQL_RANDOM_ROOT_PASSWORD=true
 - MYSQL_DATABASE=monica
 - MYSQL_USER=XXXXXXXXXXXXXXXXX
 - MYSQL_PASSWORD=XXXXXXXXXXXXXXXXXXX
 volumes:
 - /mnt/user/appdata/monica-db:/var/lib/mysql
 restart: always

 adminer:
 image: adminer
 restart: always
 ports:
 - 8282:8080

Environment File (.env)

Et voici le fichier de configuration .env :

APP_ENV=local
APP_DEBUG=false

# The encryption key. Must be 32 characters long exactly.
# Use `echo -n 'base64:'; openssl rand -base64 32` to generate a random key.
APP_KEY=XXXXXXXXXXXXXXX

# The URL of your application.
# APP_URL=http://localhost

# Set trusted proxy IP addresses.
# To trust all proxies that connect directly to your server, use a "*".
# APP_TRUSTED_PROXIES=

# Database information
# DB_CONNECTION=mysql
DB_HOST=db
DB_DATABASE=monica
DB_USERNAME=XXXXXXXXXXXX
DB_PASSWORD=XXXXXXXXXXXXXXXXXXXXX

# Mail credentials used to send emails from the application.
MAIL_DRIVER=smtp
MAIL_HOST=smtp.yourmailservice.com
MAIL_PORT=587
MAIL_USERNAME=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
MAIL_PASSWORD=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
MAIL_ENCRYPTION=tls
# Outgoing emails will be sent with these identity
MAIL_FROM_ADDRESS=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
MAIL_FROM_NAME=Monica

LOG_CHANNEL=stderr

CACHE_DRIVER=database
SESSION_DRIVER=database
QUEUE_DRIVER=sync

Note importante: Assurez-vous de remplacer les espaces réservés XXXXXXXXXXXXXXX par vos véritables informations pour les identifiants de la base de données, la clé de l’application, la configuration du service de messagerie, etc. Sans cela, l’appli ne fonctionnera pas correctement ou les emails de rappel ne fonctionneront pas…

En configurant le service cron dans un conteneur séparé, nous assurons que les tâches cron nécessaires pour envoyer les rappels par e-mail sont exécutées de manière fiable.

Si vous avez suivi mon guide précédent sur la configuration de Monica sur Unraid et rencontré ce problème, la mise en œuvre de la solution ci-dessus devrait permettre à vos rappels par e-mail de fonctionner sans problème. Pour une discussion plus approfondie ou si vous rencontrez d’autres problèmes, n’hésitez pas à visiter la page du problème GitHub de Monica ou à me contacter via le formulaire “Contactez-moi”.

Enjoy 😎

AlexIn Tech

Comment installer Monica à l'aide de Docker sur Unraid

Fri, 26 Jan 2024 00:00:00 +0000

Comment installer Monica à l’aide de Docker sur Unraid

Si vous aimez organiser votre vie personnelle en utilisant des outils digitaux et que vous aimez les solutions auto-hébergées, vous avez peut-être déjà entendu parlé de Monica. Monica est une application Web open source pour la gestion des relations personnelles. Considérez-le comme un CRM, mais pour votre vie personnelle. Aujourd’hui, je vais vous guider tout au long du processus d’installation de Monica à l’aide de Docker sur Unraid. Je vais également vous faire une explication détaillée du fichier yaml pour docker-compose que l’on va utiliser.

Prérequis

Avant de plonger dans le fichier YAML, couvrons les bases. Pour utiliser Docker Compose sur Unraid, vous devrez installer une application communautaire appelée « Docker Compose Manager ». développée par “primeval_god”. Ceci est essentiel pour exécuter le script Docker Compose YAML. Plus d’infos sur le forum Unraid.

Comprendre le fichier YAML Docker Compose

Tout d’abord, voici le fichier yaml docker-compose que j’ai produit sur la base de l’exemple officiel et j’ai aussi regardé comment Marius l’a fait avec les paramètres email :

version: "3.9"

services:
 app:
 image: monica
 depends_on:
 - db
 ports:
 - 8181:80
 environment:
 - APP_KEY= # Generate with `echo -n 'base64:'; openssl rand -base64 32`
 - DB_HOST=db
 - DB_USERNAME=monica
 - DB_PASSWORD=secret
 - APP_ENV=local
 - MAIL_MAILER=smtp
 - MAIL_HOST=smtp.gmail.com
 - MAIL_PORT=587
 - MAIL_USERNAME=Your-own-gmail-address
 - MAIL_PASSWORD=Your-own-app-password
 - MAIL_ENCRYPTION=tls
 - MAIL_FROM_ADDRESS=Your-own-gmail-address
 - MAIL_FROM_NAME=Monica
 volumes:
 - /mnt/user/appdata/monica:/var/www/html/storage
 restart: always

 db:
 image: mariadb:11
 environment:
 - MYSQL_RANDOM_ROOT_PASSWORD=true
 - MYSQL_DATABASE=monica
 - MYSQL_USER=monica
 - MYSQL_PASSWORD=secret
 volumes:
 - /mnt/user/appdata/monica-db:/var/lib/mysql
 restart: always

Décomposons ensemble ce fichier YAML pour docker-compose ! (J’ai décidé d’expliquer comment s’articulait ce fichier car c’était la première fois que j’utilisais docker-compose, j’ai donc du faire cet effort de tout décortiquer).

Version

version: "3.9"

Cette ligne spécifie la version du format de fichier Docker Compose. J’ai utilisé celui de l’exemple officiel.

Services

La section services définit les containers que nous exécuterons.

Service d’application

services:
 app:
 image: monica
 ...

image : monica : spécifie l’image Docker à utiliser, dans ce cas, ‘monica’.
depends_on: - db : garantit que le service de base de données (db) est démarré avant l’application.
ports : - 8181:80 : mappe le port 80 dans le conteneur au port 8181 sur la machine hôte (Unraid).

Variables d’environnement

APP_KEY : une clé pour le chiffrage de votre application. Générez une clef de 32 caractères.
DB_HOST=db ainsi que les autres variables (user, password) en lien avec la base de données.
MAIL_* : Configuration pour l’envoi d’e-mails via l’application.

Volumes

/mnt/user/appdata/monica:/var/www/html/storage : mappe un répertoire sur votre hôte (Unraid) à un répertoire dans le conteneur pour un stockage persistant. Par défaut, les conteneurs Unraid stockeront les données dans /mnt/user/appdata/name_of_your_container

Politique de restart

restart : toujours : garantit que le conteneur redémarre toujours à moins qu’il ne soit arrêté manuellement.

Service de base de données

 db:
 image: mariadb:11
 ...

image : mariadb:11 : Spécifie l’image MariaDB à utiliser pour la base de données.
environnement : similaire au service d’application, il est utilisé pour la configuration de la base de données.
volumes : garantit la persistance des données pour la base de données.

Modifiez les valeurs de vos variables

Avant de déployer Monica à l’aide du fichier Docker Compose YAML, il est crucial de personnaliser certaines valeurs pour les adapter à votre configuration :

APP_KEY : il s’agit d’une clé de chiffrement unique pour votre instance.
Identifiants de base de données : DB_USERNAME, DB_PASSWORD et leurs valeurs correspondantes dans le service db doivent être défini pour l’identification à la DB.
Configuration de la messagerie : ajustez les variables MAIL_* avec vos paramètres de messagerie. Cela inclut les détails de votre fournisseur de messagerie et les informations d’identification pour l’envoi d’e-mails depuis Monica. Concernant l’email j’utilise un mot de passe d’application pour mon adresse Gmail.
Volumes : les chemins dans la section volumes doivent être ajustés en fonction de où vous souhaitez stocker les données de Monica.
Ajustement des ports : il est essentiel de s’assurer que le port défini dans la section ports (par exemple, 8181:80) n’entre pas en conflit avec d’autres services sur votre serveur Unraid. Remplacez 8181 par n’importe quel port disponible sur votre hôte.

Faire ces ajustements est la clé d’une installation Monica réussie et personnalisée sur votre serveur Unraid.

Installer Monica sur Unraid

Installer Docker Compose Manager sur Unraid

Vous le trouverez dans les applications communautaires :

Accédez à l’onglet “Docker” dans le menu de Unraid puis, tout en bas, après la liste de vos containers existants vous trouverz ceci : “Compose”

Créez la stack à l’aide du fichier YAML

Cliquez sur “ADD NEW STACK” et choisissez le nom de votre stack, par exemple “Monica”

Vous devriez recevoir un message de réussite après avoir cliqué sur OK

Modifions maintenant la stack :

Cliquez sur “EDIT STACK”

Choisissez « COMPOSE FILE » ;

Copiez le contenu de votre fichier YAML et remplacez tout ici. Puis cliquez sur “ENREGISTRER LES MODIFICATIONS”.

Ensuite vous aurez la fenêtre suivante :

Remplacer Icon par certaines URL d’icônes, par exemple j’ai utilisé celles-ci :

Icône de l’application : https://pbs.twimg.com/profile_images/951820722191720450/mtCNuIXX_400x400.jpg

Icône db : https://mariadb.com/wp-content/uploads/2019/11/mariadb-logo-vert_blue-transparent.png

Et écrivez simplement l’URL de votre interface utilisateur Web pour l’application, elle ressemblera donc à quelque chose comme : http://votre_unraid_IP:votrePort/

Laissez vide pour le shell.

Et appuyez sur OK . Une fois terminé, cliquez sur « COMPOSE UP » ; pour exécuter docker-compose et tout installer :

Cela ouvrira une fenêtre qui affichera la progression

Et vous avez terminé !

FÉLICITATIONS ! Vous avez réussi à self-hoster Monica et vous avez appris à créer votre fichier yaml docker-compose ainsi qu’à l’utiliser !

Vous pouvez désormais accéder à Monica en allant sur http://your_unraid_IP:yourPort/ !

En suivant ces étapes, vous devriez avoir une instance fonctionnelle de Monica sur votre serveur Unraid, personnalisée selon vos préférences. C’est un excellent exemple de la flexibilité qu’offre Docker et un projet parfait pour plonger dans Docker Compose !

Enjoy ! 😎

AlexIn Tech

Update du 04.02.2024 : Les reminders par email ne s’envoient pas, comment résoudre ce problème ?

J’ai comme vous rencontré ce problème, et après quelques jours de recherche j’ai maintenant une solution que je vous partage dans le prochain article sur Monica !

Comment configurer un serveur privé Palworld et sécuriser son accès

Sat, 20 Jan 2024 00:00:00 +0000

Comment configurer un serveur privé Palworld et sécuriser son accès

Bonjour à tous,

L’accès anticipé à Palworld vient de sortir et comme j’aimerais jouer avec mes amis, j’ai décidé de configurer un serveur palworld dédié et sécurisé.

serveur palworld dédié et sécurisé

Le projet - Serveur privé Palworld

J’aimerais gérer un serveur privé Palworld mais en gardant la sécurité à l’esprit. Je ne veux pas l’exposer au public et je ne veux pas ouvrir de ports sur mon routeur. De plus, je préfère exécuter ce type d’applications/serveurs directement dans des conteneurs Docker.

Comme j’ai un serveur Unraid chez moi, j’ai choisi d’y exécuter un conteneur Docker du serveur Palworld et d’utiliser Tailscale afin d’accéder en toute sécurité au serveur.

Commençons !

Installer le serveur Palworld

J’utilise donc une image de conteneur Docker pour exécuter Palworld. Cette image Docker a été préparée par “ich777”.

Si vous avez un serveur Unraid comme moi, allez simplement sur votre serveur Unraid, puis accédez à “Apps”. et installez cette image docker :

Image Docker Palworld par ich777

L’installation prendra un certain temps car il faut télécharger tous les fichiers liés au jeu.

Modifiez le fichier de configuration de votre serveur palworld

Arrêtez votre conteneur Docker.

La configuration se trouve à l’adresse : …/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini

Ici, vous pouvez modifier les paramètres de votre choix pour votre serveur, mais vous devez au moins modifier les éléments suivants :

ServerName="TheNameOfYourServer",
ServerDescription="Descriptions of your server",
AdminPassword="YourAdminPWD",
ServerPassword="NOPASSWORD-REMOVE",
PublicPort=8211,
PublicIP="YourTailScaleUnraidServerIP"

⚠️ À l’heure actuelle, il y a un problème d’accès à Palworld via une adresse IP si vous avez configuré un mot de passe dans le fichier de configuration de votre serveur Palworld. Supprimez donc le « mot de passe du serveur ». et définissez simplement :

ServerPassword=""

Mais comme nous utilisons tailscale, tout est sécurisé par tailscale, nous n’aurons donc pas besoin de cette sécurité (le mot de passe) pour accéder au serveur. Seuls les utilisateurs autorisés du tailnet pourront accéder à cette adresse IP et à ce port. Merci aux ACL. ⚠️

Update 2025 : Plutôt qu’utiliser les ACLs , j’utilise la nouvelle intégration de Tailscale avec Unraid qui permet de facilement configurer Tailscaile au niveau du container , et de partager simplement le container avec des contacts. On va sur le container palworld dans notre liste de machines sur tailscale et on fait “partager” (voir photo ci-dessous).

Une fois terminé, vous pouvez relancer votre container Docker.

Installer Tailscale sur votre serveur

Concernant la configuration de tailscale, comme j’utilise un serveur Unraid, je vous redirige vers cet article incroyable d’Ibracorp.

https://docs.ibracorp.io/tailscale/

ACLs Tailscale

Nous allons maintenant configurer les ACL.

Dans tailscale, invitez vos amis à rejoindre votre tailnet :

panneau d’administration tailscale

Configurez ensuite les ACL, pour cela cliquez sur “Access controls” près de « Users ».

Voici un exemple de ce que vous pouvez faire :

{
 // Declare static groups of users.
 "groups": {
 "group:owner": ["your_email_address_as_you_are_the_owner"],
 "group:myfriends": [
 "myfriend1@gmail.com",
 "myfriend2@gmail.com",
 ],
 },

 "acls": [
 // Rule for the "owner" group - full access
 {
 "action": "accept",
 "src": ["group:owner"],
 "dst": ["*:*"],
 },
 {
 "action": "accept",
 "src": ["group:myfriends"],
 "dst": ["mytailscaleunraidserverip:8211"],
 },
 ],
}

Ici, ce que j’ai fait dans cet exemple, c’est d’autoriser le groupe"myfriends" à accéder accéder uniquement à l’adresse IP de mon serveur Unraid uniquement sur le port utilisé par le serveur Palworld.

Mon serveur n’est donc pas accessible au public, seuls mes amis qui ont installé Tailscale sur leurs ordinateurs peuvent accéder à ce serveur. Et ils ne peuvent accéder qu’au serveur Palworld et non aux autres serveurs ou services qui pourraient s’exécuter sur mon serveur Unraid.

C’est le moment de jouer !

Assurez-vous que tailscale est installé sur votre ordinateur et que vous faites partie du réseau tailnet de la personne hébergeant le serveur. Assurez-vous d’être connecté à tailscale. Et…

Lancez le jeu !

palworld accède à un serveur dédié sécurisé

Entrez l’ip tailscale de votre serveur et son port :

palworld entrez l’adresse IP du serveur

Enjoy ! 🤓🕹️