Browse Source

added readme to docker_features example

Natan 1 year ago
parent
commit
01c187003b
1 changed files with 15 additions and 0 deletions
  1. 15 0
      examples/docker_features/README.md

+ 15 - 0
examples/docker_features/README.md

@@ -0,0 +1,15 @@
+# Utilizing Docker signals and persistant storage.
+
+This example shows how to utilize the features implemented into the NiceGUI release docker image. 
+* Intercept signals passed from Docker to issue a graceful shutdown of NiceGUI.
+* Volume mounting the .nicegui directory for persistant storage which will retain on container rebuild.
+
+## Try it out.
+
+Alter the docker-compose.yml file to your local host user's uid\gid and host storage path.
+
+```bash
+docker-compose up
+```
+
+Then you can access http://localhost:8080 and enter in data for storage. If you stop the container and look at the logs you should see it initiated ui.shutdown method.