linuxserver/docker-heimdall
1
0
Fork 0
mirror of https://github.com/linuxserver/docker-heimdall.git synced 2025-10-26 18:53:40 +09:00
Code Issues Packages Projects Releases Wiki Activity

Bot Updating Templated Files

Browse Source
This commit is contained in:
LinuxServer-CI
2024-12-06 18:44:22 +00:00
parent 54548adcc7
commit 274349166b
2 changed files with 17 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -78,11 +78,13 @@ Access the web gui at http://SERVERIP:PORT
This image now supports password protection through htpasswd. Run the following command on your host to generate the htpasswd file `docker exec -it heimdall htpasswd -c /config/nginx/.htpasswd <username>`. Replace <username> with a username of your choice and you will be asked to enter a password. Uncomment the `basic auth` lines in `/config/nginx/site-confs/default.conf` and restart the container.
## Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>[!NOTE]
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
```yaml
@@ -124,8 +126,8 @@ Containers are configured using parameters passed at runtime (such as those abov
| Parameter | Function |
| :----: | --- |
| `-p 80` | http gui |
| `-p 443` | https gui |
| `-p 80:80` | http gui |
| `-p 443:443` | https gui |
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |