move example folder

example-role/README.md

@@ -0,0 +1,7 @@
+# Example role
+
+Once you will need to add your own software into Lokal then you will
+appreciate this folder. There is quite detailed [documentation](https://docs.lokal.network/) but it
+is missing details on how to add your own roles.
+
+

example-role/defaults/main.yml

@@ -0,0 +1,9 @@
+version_yourapp: "13"
+
+# Security does not matter much here because all connections
+# to the database are blocked from outside. To get a security
+# breach, you would need to install the security thread yourself
+mysql_user_yourapp: "your_app"
+mysql_password_yourapp: "your_app"
+mysql_database_yourapp: "your_app"
+

example-role/files/your-static-file.txt

@@ -0,0 +1,7 @@
+This is just an example of a static file - can be a binary or anything
+else that will get copied to the remote server and bound in a folder
+into the docker container. Thus it will be accessible on predefined
+path. This file will be copied with the {{ansible_user}} user and
+priviledges. It will be mounted in the docker with {{uid}}:{{gid}}
+permissions which are usually 1000:1000. We aim to run all containers
+unpriviledged.

example-role/templates/service.conf.j2

@@ -0,0 +1,12 @@
+# This is an example config file for your example services
+# It can have any format because you use jinja2 templates
+
+# Available variables are composed from following files:
+#  - roles/lokal/defaults/main.yml
+#  - roles/<your-service>/defaults/main.yml
+#  - hosts/<your-host-file>.yml
+
+HOST: {{domain}}
+
+MY_COSTOM_VARIABLE: 5
+HELLO: "world"