Skip to content

Commit

Permalink
add list of files to modify through ASSET_DIR env var
Browse files Browse the repository at this point in the history
  • Loading branch information
sdumetz committed May 13, 2024
1 parent 0bc0d16 commit 2c24618
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 41 deletions.
57 changes: 37 additions & 20 deletions en/doc/references/administration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ All configuration options are provided by environment variables.
Leaving the default value is generally a good choice.

For boolean variables, use `1` or `true` / `0` or `false`.
### Environment variables

### Basic variables
#### Basic variables

#### NODE_ENV
##### NODE_ENV

> `development`
Expand All @@ -24,29 +25,29 @@ Changes the behavior of some modules. See also [express](https://expressjs.com/e

Should generally be forced to `production` in deployments.

### HOSTNAME
#### HOSTNAME

#### PUBLIC
##### PUBLIC

> `true`
Default access of newly created scenes.

Does not modify existing scenes. It is still possible to create a publicly accessible scene by changing its permissions even if `PUBLIC=0`.

#### BRAND
##### BRAND

> `eCorpus`
Name of the instance. Replaces **eCorpus** in the interface.

#### PORT
##### PORT

> `3000`
Port used by the service. Change in case of conflict.

#### SMART_HOST
##### SMART_HOST

> `smtp://localhost`
Expand All @@ -63,73 +64,89 @@ smtp://localhost:465?tls.rejectUnauthorized=false
See the full [list](https://nodemailer.com/smtp/){:target="_blank"}.


#### TRUST_PROXY
##### TRUST_PROXY

> `true`
Changes express's trust-proxy option. See [express](http://expressjs.com/en/5x/api.html#trust.proxy.options.table){:target="_blank"}.


### administration variables
#### administration variables

#### FORCE_MIGRATION
##### FORCE_MIGRATION

> `false`
Force reapply of the last *sqlite* migration (see [doc](https://www.npmjs.com/package/sqlite#migrations){:target="_blank"}).

Sometimes useful to repair migration errors, but generates a risk of data loss.

#### CLEAN_DATABASE
##### CLEAN_DATABASE

> `true`
Set to `false` to disable periodic database cleanup.

#### ROOT_DIR
##### ROOT_DIR

> `.`
Main directory. Serves as a base for [FILES_DIR](#files_dir) [DIST_DIR](#dist_dir) and [ASSETS_DIR](#assets_dir).

#### MIGRATIONS_DIR
##### MIGRATIONS_DIR

> `./migrations`
#### TEMPLATES_DIR
##### TEMPLATES_DIR

> `./templates`
#### FILES_DIR
##### FILES_DIR

> `$ROOT_DIR/files`
Data storage directory of the instance: Database, objects and temporary storage.

#### DIST_DIR
##### DIST_DIR

> `$ROOT_DIR/dist`
build artifacts of the user interface.

#### ASSETS_DIR
##### ASSETS_DIR

> `$ROOT_DIR/assets`
Static assets

### Variables de développement
#### development variables

#### HOT_RELOAD
##### HOT_RELOAD

> `$NODE_ENV == "development"`
Activates webpack's [HMR](https://webpack.js.org/concepts/hot-module-replacement/){:target="_blank"}.

#### VERBOSE
##### VERBOSE

> `false`
Verbose mode


### Editable files

Using the [ASSETS_DIR](#assets_dir) variable, it is possible to modify the files normally included in the `/dist` folder. In particular:

```
dist/
├─ css/
│ ├─ theme.css
├─ images/
│ ├─ logo-full.svg
│ ├─ logo-sm.svg
│ ├─ spinner.svg
├─ favicon.svg
├─ favicon.png
```

60 changes: 39 additions & 21 deletions fr/doc/references/administration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ Laisser la valeur par défaut est généralement un bon choix.

Pour les variables booléennes, utiliser `1` ou `true` / `0` ou `false`.

### Variables d'environnement

### Variables de base
#### Variables de base

#### NODE_ENV
##### NODE_ENV

> `development`
Expand All @@ -25,31 +26,31 @@ Change le comportement de certains modules. Voir aussi [express](https://express

Devrait généralement être forcé à `production` dans les déploiements.

### HOSTNAME
#### HOSTNAME

#### PUBLIC
##### PUBLIC

> `true`
Accès par défaut des scènes nouvellement créées.

Ne modifie pas les scènes existantes. Il est toujours possible de créer une scène publiquement accessible en changeant ses permissions même si `PUBLIC=0`.

#### BRAND
##### BRAND

> `eCorpus`
Nom de l'instance. Remplace **eCorpus** dans l'interface.


#### PORT
##### PORT

> `3000`
Port utilisé par le service. Changer en cas de conflit.


#### SMART_HOST
##### SMART_HOST

> `smtp://localhost`
Expand All @@ -66,71 +67,88 @@ smtp://localhost:465?tls.rejectUnauthorized=false
D'autres options utiles peuvent être : `?logger=true&debug=true` pour activer le mode verbeux. Voir la [liste des options](https://nodemailer.com/smtp/){:target="_blank"}.


#### TRUST_PROXY
##### TRUST_PROXY

> `true`
Pilote l'option trust-proxy dans [express](http://expressjs.com/en/5x/api.html#trust.proxy.options.table){:target="_blank"}.


### Variables d'administration
#### Variables d'administration

#### FORCE_MIGRATION
##### FORCE_MIGRATION

> `false`
Force l'application de la dernière migration *sqlite* (voir [doc](https://www.npmjs.com/package/sqlite#migrations){:target="_blank"}).

Parfois utile pour réparer des erreurs de migration, mais génère un risque de perte de données.

#### CLEAN_DATABASE
##### CLEAN_DATABASE

> `true`
Mettre à `false` pour désactiver le nettoyage périodique de base de données.

#### ROOT_DIR
##### ROOT_DIR

> `.`
Répertoire principal. Sert de base pour [FILES_DIR](#files_dir) [DIST_DIR](#dist_dir) et [ASSETS_DIR](#assets_dir).

#### MIGRATIONS_DIR
##### MIGRATIONS_DIR

> `./migrations`
#### TEMPLATES_DIR
##### TEMPLATES_DIR

> `./templates`
#### FILES_DIR
##### FILES_DIR

> `$ROOT_DIR/files`
Répertoire de stockage des données de l'instance : base de donnée, objets et stockage temporaire.

#### DIST_DIR
##### DIST_DIR

> `$ROOT_DIR/dist`
artefacts de build de l'interface utilisateur.

#### ASSETS_DIR
##### ASSETS_DIR

> `$ROOT_DIR/assets`
Assets statiques

### Variables de développement
#### Variables de développement

#### HOT_RELOAD
##### HOT_RELOAD

> `$NODE_ENV == "development"`
Active le [HMR](https://webpack.js.org/concepts/hot-module-replacement/){:target="_blank"} de webpack.

#### VERBOSE
##### VERBOSE

> `false`
Mode verbeux
Mode verbeux

### Fichiers modifiables

En utilisant la variable [ASSETS_DIR](#assets_dir), il est possible de modifier les fichiers normalement inclus dans le dossier `/dist`. En particulier :

```
dist/
├─ css/
│ ├─ theme.css
├─ images/
│ ├─ logo-full.svg
│ ├─ logo-sm.svg
│ ├─ spinner.svg
├─ favicon.svg
├─ favicon.png
```

0 comments on commit 2c24618

Please sign in to comment.