From c30d2f7161ccd44d8e7514427f5073b726e6e6ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89loi=20Rivard?= Date: Fri, 30 Jun 2023 23:52:22 +0200 Subject: [PATCH] Moved config.sample directly in canaille --- CONTRIBUTING.rst | 2 +- MANIFEST.in | 2 +- canaille/{conf => }/config.sample.toml | 4 ++-- doc/configuration.rst | 4 ++-- doc/install.rst | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) rename canaille/{conf => }/config.sample.toml (98%) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 93cb75ef..c308f8fd 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -70,7 +70,7 @@ You can populate the database with randomly generated users and groups with the .. code-block:: console # If using docker: - docker compose exec canaille env CONFIG=conf/canaille.toml poetry run canaille populate --nb 100 users # or docker-compose + docker compose exec canaille env CONFIG=conf-docker/canaille.toml poetry run canaille populate --nb 100 users # or docker-compose # If running in local environment env CONFIG=conf/canaille.toml poetry run canaille populate --nb 100 users diff --git a/MANIFEST.in b/MANIFEST.in index 30003764..dbbdf110 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include canaille/conf/*.sample.* +include canaille/*.sample.* graft canaille/backends/ldap/schemas graft canaille/templates graft canaille/themes diff --git a/canaille/conf/config.sample.toml b/canaille/config.sample.toml similarity index 98% rename from canaille/conf/config.sample.toml rename to canaille/config.sample.toml index cef87461..fdf54917 100644 --- a/canaille/conf/config.sample.toml +++ b/canaille/config.sample.toml @@ -187,9 +187,9 @@ WRITE = [ [OIDC.JWT] # The path to the private key. -PRIVATE_KEY = "canaille/conf/private.pem" +PRIVATE_KEY = "canaille/private.pem" # The path to the public key. -PUBLIC_KEY = "canaille/conf/public.pem" +PUBLIC_KEY = "canaille/public.pem" # The URI of the identity provider # ISS = "https://auth.mydomain.tld" # The key type parameter diff --git a/doc/configuration.rst b/doc/configuration.rst index 67227fe6..ab460337 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -194,11 +194,11 @@ Canaille needs a key pair to sign the JWT. The installation command will generat :PRIVATE_KEY: **Required.** The path to the private key. - e.g. ``/path/to/canaille/conf/private.pem`` + e.g. ``/path/to/private.pem`` :PUBLIC_KEY: **Required.** The path to the public key. - e.g. ``/path/to/canaille/conf/private.pem`` + e.g. ``/path/to/public.pem`` :ISS: *Optional.* The URI of the identity provider. diff --git a/doc/install.rst b/doc/install.rst index 90c6cc98..a9fe94b2 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -32,7 +32,7 @@ Choose a path where to store your configuration file. You can pass any configura export CANAILLE_CONF_DIR=/etc/canaille sudo mkdir --parents "$CANAILLE_CONF_DIR" - sudo cp $CANAILLE_INSTALL_DIR/env/lib/python*/site-packages/canaille/conf/config.sample.toml "$CANAILLE_CONF_DIR/config.toml" + sudo cp $CANAILLE_INSTALL_DIR/env/lib/python*/site-packages/canaille/config.sample.toml "$CANAILLE_CONF_DIR/config.toml" You should then edit your configuration file to adapt the values to your needs.