refactor: remove SILL_ in env variable and simplify setup in env.ts

Author: JeromeBu

api/src/env.ts

@@ -24,20 +24,19 @@ const zEnvConfiguration = z.object({
 
 const envConfiguration = zEnvConfiguration.parse({
     "oidcParams": {
-        "issuerUri":
-            process.env.OIDC_ISSUER_URI ?? `${process.env.SILL_KEYCLOAK_URL}/realms/${process.env.SILL_KEYCLOAK_REALM}`,
-        "clientId": process.env.OIDC_CLIENT_ID ?? process.env.SILL_KEYCLOAK_CLIENT_ID
+        "issuerUri": process.env.OIDC_ISSUER_URI,
+        "clientId": process.env.OIDC_CLIENT_ID
     },
-    "termsOfServiceUrl": process.env.SILL_TERMS_OF_SERVICE_URL,
-    "githubPersonalAccessTokenForApiRateLimit": process.env.SILL_GITHUB_TOKEN,
-    "port": parseInt(process.env.SILL_API_PORT ?? ""),
-    "isDevEnvironnement": process.env.SILL_IS_DEV_ENVIRONNEMENT?.toLowerCase() === "true",
-    "externalSoftwareDataOrigin": process.env.SILL_EXTERNAL_SOFTWARE_DATA_ORIGIN,
-    "redirectUrl": process.env.SILL_REDIRECT_URL,
+    "termsOfServiceUrl": process.env.TERMS_OF_SERVICE_URL,
+    "githubPersonalAccessTokenForApiRateLimit": process.env.GITHUB_TOKEN,
+    "port": parseInt(process.env.API_PORT ?? ""),
+    "isDevEnvironnement": process.env.IS_DEV_ENVIRONNEMENT?.toLowerCase() === "true",
+    "externalSoftwareDataOrigin": process.env.EXTERNAL_SOFTWARE_DATA_ORIGIN,
+    "redirectUrl": process.env.REDIRECT_URL,
     "databaseUrl": process.env.DATABASE_URL,
     "initializeSoftwareFromSource": process.env.INIT_SOFT_FROM_SOURCE?.toLowerCase() === "true",
     "botAgentEmail": process.env?.BOT_AGENT_EMAIL,
-    "listToImport": process.env?.SILL_IMPORT_WIKIDATA?.split(",")
+    "listToImport": process.env?.IMPORT_WIKIDATA?.split(",")
 });
 
 export const env = {

deployments/docker-compose-example/.env.sample

@@ -1,27 +1,15 @@
-SILL_KEYCLOAK_URL=http://localhost:8081/auth
-SILL_KEYCLOAK_REALM=codegouv
-SILL_KEYCLOAK_CLIENT_ID=sill
-SILL_README_URL=https://raw.githubusercontent.com/codegouvfr/sill/refs/heads/main/README.md
-SILL_TERMS_OF_SERVICE_URL=https://code.gouv.fr/sill/tos_fr.md
-SILL_JWT_ID=sub
-SILL_JWT_EMAIL=email
-SILL_JWT_ORGANIZATION=organization
-SILL_GITHUB_TOKEN=xxxxx
-SILL_API_PORT=3084
-SILL_IS_DEV_ENVIRONNEMENT=true
-SILL_EXTERNAL_SOFTWARE_DATA_ORIGIN=wikidata
-SILL_IMPORT_WIKIDATA=Q10135,Q25874683
+OIDC_ISSUER_URI=https://auth.code.gouv.fr/auth/realms/codegouv
+OIDC_CLIENT_ID=sill
+
+TERMS_OF_SERVICE_URL=https://code.gouv.fr/sill/tos_fr.md
+
+API_PORT=3084
+IS_DEV_ENVIRONNEMENT=true
+EXTERNAL_SOFTWARE_DATA_ORIGIN=wikidata
+IMPORT_WIKIDATA=Q10135,Q25874683
 INIT_SOFT_FROM_SOURCE=false
 BOT_AGENT_EMAIL=[email protected]
 
 DATABASE_URL=postgresql://sill:pg_password@localhost:5432/sill
 
-# Theses variables are used by docker-compose files to create the Postgres docker
-POSTGRES_DB=sill
-POSTGRES_USER=sill
-POSTGRES_PASSWORD=pg_password
-
-# this is only for the script load-git-repo-in-pg.ts, not needed for api any more
-SILL_DATA_REPO_SSH_URL=[email protected]:codegouvfr/sill-data-test.git
-SILL_SSH_NAME=id_ed25519
-SILL_SSH_PRIVATE_KEY="-----BEGIN OPENSSH PRIVATE KEY-----\n....PASTE_YOUR_KEY...\n-----END OPENSSH PRIVATE KEY-----\n"
+# REDIRECT_URL=https://your-redirect-url

docs/deploying-the-web-app-bare-metal.md

@@ -53,11 +53,10 @@ Create a `.env` file with a content like this
 ```
 OIDC_ISSUER_URI=http://localhost:8081/auth/realms/codegouv
 OIDC_CLIENT_ID=sill
-SILL_README_URL=https://raw.githubusercontent.com/codegouvfr/sill/refs/heads/main/docs/sill.md
-SILL_TERMS_OF_SERVICE_URL=https://code.gouv.fr/sill/tos_fr.md
-SILL_GITHUB_TOKEN=ghp_xxxxxx
-SILL_API_PORT=3084
-SILL_IS_DEV_ENVIRONNEMENT=true
+TERMS_OF_SERVICE_URL=https://code.gouv.fr/sill/tos_fr.md
+GITHUB_TOKEN=ghp_xxxxxx
+API_PORT=3084
+IS_DEV_ENVIRONNEMENT=true
 DATABASE_URL=postgresql://sill:pg_password@localhost:5432/sill
 ```
 

docs/deploying-with-docker-compose.md

@@ -10,7 +10,7 @@ cp .env.sample .env
 
 You will need to provide an ssh key in SILL_SSH_PRIVATE_KEY, and it should have the access to the repo you provide in SILL_DATA_REPO_SSH_URL
 
-You will also need to provide a SILL_GITHUB_TOKEN.
+You will also need to provide a GITHUB_TOKEN.
 
 You can change the way you handle the frontal part in the [nging configuration file](https://github.com/codegouvfr/sill/blob/main/deployments/docker-compose-example/nginx/default.conf).
 The provided example is basic, and for example it does not provide support for `https` (you would need to configure it with you SSL certificates).

docs/setting-up-a-development-environment.md

@@ -26,11 +26,10 @@ Makes sure to put the name of your SSH key and the private key (generated when y
 ```
 OIDC_ISSUER_URI=http://localhost:8081/auth/realms/codegouv
 OIDC_CLIENT_ID=sill
-SILL_README_URL=https://raw.githubusercontent.com/codegouvfr/sill/refs/heads/main/docs/sill.md
-SILL_TERMS_OF_SERVICE_URL=https://code.gouv.fr/sill/tos_fr.md
-SILL_GITHUB_TOKEN=ghp_xxxxxx
-SILL_API_PORT=3084
-SILL_IS_DEV_ENVIRONNEMENT=true
+TERMS_OF_SERVICE_URL=https://code.gouv.fr/sill/tos_fr.md
+GITHUB_TOKEN=ghp_xxxxxx
+API_PORT=3084
+IS_DEV_ENVIRONNEMENT=true
 DATABASE_URL=postgresql://sill:pg_password@localhost:5432/sill
 ```