From f5cc1d0778af4a2ef8ae81d506b8784421fa7f4f Mon Sep 17 00:00:00 2001 From: aptalca Date: Tue, 6 Feb 2018 21:27:24 -0500 Subject: [PATCH] Update README.md --- README.md | 46 +++++++++++++++++----------------------------- 1 file changed, 17 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 4ccf51c..ec2c089 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ [forumurl]: https://forum.linuxserver.io [ircurl]: https://www.linuxserver.io/irc/ [podcasturl]: https://www.linuxserver.io/podcast/ -[appurl]: https://nginx.org/ -[hub]: https://hub.docker.com/r/linuxserver/nginx/ +[appurl]: https://github.com/linuxserver/Heimdall +[hub]: https://hub.docker.com/r/linuxserver/heimdall/ [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] @@ -12,10 +12,14 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f * [IRC][ircurl] on freenode at `#linuxserver.io` * [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! -# linuxserver/nginx +# linuxserver/heimdall [![](https://images.microbadger.com/badges/version/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nginx.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nginx.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-nginx)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-nginx/) -This Container is a simple nginx webserver configured with default and ssl, and all relevant config files moved out the user via /config for ultimate control. it contains some of the basic php-packages. and is built on our internal nginx baseimage. +Heimdall is a way to organise all those links to your most used web sites and web applications in a simple way. + +Simplicity is the key to Heimdall. + +Why not use it as your browser start page? It even has the ability to include a search bar using either Google, Bing or DuckDuckGo. [![nginx](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/nginx-banner.png)][appurl] @@ -23,12 +27,12 @@ This Container is a simple nginx webserver configured with default and ssl, and ``` docker create \ ---name=nginx \ +--name=heimdall \ -v :/config \ -e PGID= -e PUID= \ -p 80:80 -p 443:443 \ -e TZ= \ -linuxserver/nginx +linuxserver/heimdall ``` ## Parameters @@ -45,8 +49,9 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po * `-e PGID` for GroupID - see below for explanation * `-e PUID` for UserID - see below for explanation * `-e TZ` - timezone ie. `America/New_York` +* `-e BASEURL` - _optional_ - you can set a base url through this variable to serve the app at http://SERVERIP:PORT/BASEURL -It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it nginx /bin/bash`. +It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it heimdall /bin/bash`. ### User / Group Identifiers @@ -61,38 +66,21 @@ In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as bel ## Setting up the application -Add your web files to /config/www for hosting. - -*Protip: This container is best combined with a sql server, e.g. [mariadb](https://hub.docker.com/r/linuxserver/mariadb/)* - +Access the web gui at http://SERVERIP:PORT ## Info -* To monitor the logs of the container in realtime `docker logs -f nginx`. +* To monitor the logs of the container in realtime `docker logs -f heimdall`. * container version number -`docker inspect -f '{{ index .Config.Labels "build_version" }}' nginx` +`docker inspect -f '{{ index .Config.Labels "build_version" }}' heimdall` * image version number -`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/nginx` +`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/heimdall` ## Versions -+ **05.01.18:** Rebase to alpine 3.7 -+ **08.11.17:** Add php7 soap module -+ **31.10.17:** Add php7 exif and xmlreader modules -+ **30.09.17:** Copy additional root files into image -+ **24.09.17:** Add memcached service -+ **31.08.17:** Add php7-phar -+ **14.07.17:** Enable modules dynamically in nginx.conf -+ **22.06.17:** Add various nginx modules and enable all modules in the default nginx.conf -+ **05.06.17:** Add php7-bz2 -+ **25.05.17:** Rebase to alpine 3.6. -+ **18.04.17:** Add php7-sockets -+ **27.02.17:** Rebase to alpine 3.5, update to nginx 1.10.2 and php7 -+ **14.10.16:** Add version layer information. -+ **10.09.16:** Add badges to README. -+ **05.12.15:** Intial Release. ++ **XX.02.18:** Intial Release.