This project was built around Docker version 25.0 and Docker Compose plugin version 2.27.
A Taskfile.yml
is present at the root of the repository which containers the common commands to bootstrap the project. Subfiles stands in the directory tasks
and are imported at the beginning of the main file.
You can install the task
CLI through their website at taskfile.dev/installation.
To bootstrap the project, first run the init
command:
task init
This will copy the default .env, build images and install NodeJS dependencies.
You needs to update the .env with the following information:
-
AUTH_SECRET
can be generate with this command:docker compose run --rm --no-deps app npx auth secret
-
AUTH_GOOGLE_ID
andAUTH_GOOGLE_SECRET
are available in Google Cloud Platform under APIs & Services > Credentials. As of writing those lines, only two possibility remains :- use the
KNP Hot Tools (localhost)
for development purpose only ; - use the
KNP Hot Tools (prod)
for production server under knpnet.net domain ;
- use the
-
AUTH_GOOGLE_RESTRICT_DOMAIN
might be blank during development, so you can loggin with any Google account or with@knplabs.com
to restrict Google account from KNP Labs.
Simply run:
task start
You can start Adminer with the following command:
docker compose --profile adminer up -d adminer
You can si all available shortcuts defined with Taskfile with this command1:
task --list
Footnotes
-
Only shortcuts with a description (
desc
) are displayed ↩