Si vous utilisez PostgreSQL, vous devez créer une base de données pour Plume.
service postgresql start
su - postgres
createuser -d -P plume
createdb -O plume plume
Avant de lancer Plume, vous devez créer un fichier de configuration nommé .env
.
Ce fichier doit être situé dans le même répertoire que celui dans lequel vous allez démarrer Plume (~/Plume
, si vous avez suivi les instructions précédentes).
Si vous installez depuis les sources, vous pouvez utiliser cp .env.sample .env
pour le générer.
Voici un exemple de ce que vous pourriez mettre pour des systèmes GNU/Linux et Mac OS X.
# L'adresse de la base de donnée
# (remplacez USER, PASSWORD, PORT et DATABASE_NAME avec vos valeurs)
#
# Si vous utilisez SQlite, utilisez le chemin absolu vers le fichier de base données (`plume.db` par exemple)
# Les chemins de Windows utilisent des anti-slashs, changez les pour des slashs
#DATABASE_URL=/etc/path/to/Plume/plume.db
DATABASE_URL=postgres://USER:PASSWORD@IP:PORT/DATABASE_NAME
# Pour PostgreSQL: migrations/postgres
# Pour SQlite: migrations/sqlite
MIGRATION_DIRECTORY=migrations/postgres
# Le domaine de votre instance
BASE_URL=plu.me
# La clé secrète utilisée pour générer les cookies privés et la protection CSRF
# Vous pouvez en générer une avec `openssl rand -base64 32`
ROCKET_SECRET_KEY=
# Paramètres mails
# Si vous ne souhaitez pas utiliser un serveur mail et/ou d'adresse pour plume
# et ne comptez pas utiliser la fonctionnalité de "réinitialisation des mots de passes"
# vous pouvez commenter ces lignes
MAIL_SERVER=smtp.example.org
MAIL_USER=example
MAIL_PASSWORD=123456
MAIL_HELO_NAME=example.org
MAIL_ADDRESS=from@example.org
Pour plus d'informations sur ce que vous pouvez mettre dans votre .env
,
voir la documentation sur les variables d'environnement.
Maintenant nous devons lancer les migrations. Les migrations sont des scripts utilisés pour mettre à jour la base de données. Pour exécuter les migrations sur GNU/Linux et Mac OS X vous pouvez exécuter:
plm migration run
Si vous utilisez Windows et sqlite, vous devez copier sqlite3.dll depuis “C:\ProgramData\chocolatey\lib\SQLite\tools” vers l'endroit où plm.exe et plume.exe ont été compilés:
copy "C:\ProgramData\chocolatey\lib\SQLite\tools\sqlite3.dll" "C:\Users\%USERNAME%\.cargo\bin\sqlite3.dll"
Maintenant vous pouvez exécuter les migrations:
plm migration run
Les migrations doivent être lancées après chaque mise à jour. Si vous avez un doute, lancez les.
Vous devez également initialiser l'index de recherche:
plm search init
Après cela, vous devez configurer votre instance ainsi que le compte administrateur.
plm instance new
plm users new --admin
Remarque si vous voulez utiliser LDAP: vous devez quand même créer un compte administrateur, au moins pour donner les droits d'administrateur à votre propre compte LDAP une fois qu'il sera enregistré.
Sur Windows, il peut y avoir une erreur lors de la création de l'utilisateur admin. Pour la résoudre exécutez:
plm users new --admin -n "adminusername" -N "Nom affichable pour admin" -b "Biographie de admin ici" -p motdepassesimple
Pour plus d'informations sur ces commandes et sur les arguments que vous pouvez leur donner, regardez la documentation .
Maintenant que Plume est configuré, si vous êtes dans un environnement de production vous voulez sûrement configurer votre système d'initialisation pour faciliter la gestion.