Created configuration (markdown)

2021-03-19 20:26:41 +11:00
parent 633ec2b1c2
commit e47fe15fd6
1 changed files with 21 additions and 0 deletions
@@ -0,0 +1,21 @@
+# Configuration
+
+There are a set of tools for configuration included in the core project and it's microservices. These do things like outputting docker scripts. Other configuration scripts, such as CSS generators, are possible for the future.
+
+## configure-script.js
+
+This is detailed more completely in [the setup tutorial](tutorial-setup), but this prompts for a number of inputs, and generates three files using the input.
+
+Each [microservice](microservices) has it's own configure-script.js file; but the core project covers all of them at once.
+
+### docker-compose.yml
+
+This file, when generated by the core project, will pull the microservices from docker hub (along with traefik and mariadb) and will put everything together. This file is ignored by git.
+
+### Dockerfile
+
+This file covers ONLY the repo it exists in. It is committed to the repo, but is also generated by the configure-script.js for completeness.
+
+### startup.sql
+
+This file generates a script for mariadb that creates the appropiate database, and a user with the specified passwords. This file is ignored by git.