Documentation issues

Ouverte Adaptée aux débutants
#3,671 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-2 jours
Accessibilité débutants
72/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Stack technique
kubernetes, rails, ruby
Domaine
devops, documentation, infrastructure

Piste de recherche

Commencez par la documentation des variables d’environnement pour le self-hosting et par l’ancre manquante pour passer une instance existante en production, référencée depuis les logs de 1.15.0. Vérifiez la section 2FA et l’exemple de probe Kubernetes, puis documentez les variables de production requises ainsi que SMTP_AUTHENTICATION=none ; le travail est terminé lorsque le lien fonctionne et que les étapes de production listées correspondent à la configuration signalée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

BEFORE OPENING AN ISSUE, MAKE SURE YOU READ THIS: https://github.com/Freika/dawarich/issues/1382

OS & Hardware
running in 3 node k3s kubernetes cluster

Version
1.15.0

Describe the bug
I wanted to changed my self hosted instance as recommend from RAILS_ENV=development to production
the link in the logs was
https://dawarich.app/docs/self-hosting/environment-variables/#switching-an-existing-instance-to-production
but this chapter switching-an-existing-instance-to-production does not exist.

To get it working i had to add:
SECRET_KEY_BASE
=> i used openssl rand -hex 32

this variable is not listed in:
https://dawarich.app/docs/self-hosting/environment-variables/

OTP_ENCRYPTION_PRIMARY_KEY, OTP_ENCRYPTION_DETERMINISTIC_KEY, OTP_ENCRYPTION_DETERMINISTIC_SALT
i followed this https://dawarich.app/docs/self-hosting/environment-variables/#two-factor-authentication-2fa. but here is not mentioned that is mandatory for production settings.

aswell i had to adapt my probes. to include the http header:

          startupProbe:
            httpGet:
              path: /
              port: 3000
              httpHeaders:
              - name: Host
                value: "dawarich.mydomain.com"

an other one which i noticed which is not update in documentation is:
SMTP_AUTHENTICATION = none
this is not mentioned in the documentation, but i think it was introduced in one of the last releases

To Reproduce
upgrade to 1.15.0 and follow the link in the logs:
https://dawarich.app/docs/self-hosting/environment-variables/#switching-an-existing-instance-to-production

Expected behavior

  1. the link should point to the related chapter and should explain all needed changes.
  2. describe SECRET_KEY_BASE in https://dawarich.app/docs/self-hosting/environment-variables/
  3. document SMTP_AUTHENTICATION = none

Screenshots

Logs

Additional context
Add any other context about the problem here.

Langage dominant
Ruby
Étoiles
10.4k
Forks
376
Merge moyen
1 j 16 h
PR mergées (30 j)
161

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Freika/dawarich

Toutes les issues de Freika/dawarich

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.