summaryrefslogtreecommitdiffhomepage
path: root/pkg/docker/welcome.md
diff options
context:
space:
mode:
authorLiam Crilly <liam.crilly@nginx.com>2023-05-09 22:53:18 +0100
committerLiam Crilly <liam.crilly@nginx.com>2023-05-09 22:53:18 +0100
commitd48180190752201865f41b2cf1e0a6740fa2ea59 (patch)
treea059ed440ffdb84172089d3dc91af9ae03f4b686 /pkg/docker/welcome.md
parent8ab16f71fee9505d4159154179082c0aec03ca4c (diff)
downloadunit-d48180190752201865f41b2cf1e0a6740fa2ea59.tar.gz
unit-d48180190752201865f41b2cf1e0a6740fa2ea59.tar.bz2
Docker: show welcome page on port 80 when entrypoint.d is empty.
The entrypoint script now performs a default configuration when no useful files are found in /docker-entrypoint.d/ The default configuration serves a welcome page in response to all requests, using Markdown unless text/html is sent in the Accept header. This provides a useful 'hello world' experience when running a Unit container for the first time.
Diffstat (limited to 'pkg/docker/welcome.md')
-rw-r--r--pkg/docker/welcome.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/pkg/docker/welcome.md b/pkg/docker/welcome.md
new file mode 100644
index 00000000..fef3d152
--- /dev/null
+++ b/pkg/docker/welcome.md
@@ -0,0 +1,29 @@
+Welcome to NGINX Unit
+=====================
+
+Congratulations! NGINX Unit is installed and running.
+
+Useful Links
+------------
+
+ * https://unit.nginx.org/
+ - Get started with the 'Configuration' docs, starting with the 'Quick Start' guide.
+
+ * https://unit.nginx.org/howto/docker/
+ - Guidance for running Unit in a container and tips for containerized applications.
+
+ * https://github.com/nginx/unit
+ - See our GitHub repo to browse the code, contribute, or seek help from the community.
+
+Current Configuration
+---------------------
+Unit's control API is currently listening for configuration changes on the Unix socket at
+`/var/run/control.unit.sock` inside the container.
+
+Read the current configuration with
+```
+docker exec -ti <containerID> curl --unix-socket /var/run/control.unit.sock http://localhost/config
+```
+
+---
+NGINX Unit - the universal web app server