mirror of
https://github.com/DI0IK/homepage-plus.git
synced 2025-07-19 11:09:50 +00:00
add mkdocs
This commit is contained in:
parent
b215843b26
commit
47765ee05e
144 changed files with 4219 additions and 3 deletions
57
docs/installation/docker.md
Normal file
57
docs/installation/docker.md
Normal file
|
@ -0,0 +1,57 @@
|
|||
---
|
||||
title: Docker Installation
|
||||
description: Install and run homepage from Docker
|
||||
---
|
||||
|
||||
Using docker compose:
|
||||
|
||||
```yaml
|
||||
version: "3.3"
|
||||
services:
|
||||
homepage:
|
||||
image: ghcr.io/benphelps/homepage:latest
|
||||
container_name: homepage
|
||||
ports:
|
||||
- 3000:3000
|
||||
volumes:
|
||||
- /path/to/config:/app/config # Make sure your local config directory exists
|
||||
- /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations
|
||||
```
|
||||
|
||||
### Running as non-root
|
||||
|
||||
By default, the Homepage container runs as root. Homepage also supports running your container as non-root via the standard `PUID` and `PGID` environment variables. When using these variables, make sure that any volumes mounted in to the container have the correct ownership and permissions set.
|
||||
|
||||
_Using the docker socket directly is not the recommended method of integration and requires either running homepage as root or that the user be part of the docker group_
|
||||
|
||||
In the docker compose example below, the environment variables `$PUID` and `$PGID` are set in a `.env` file.
|
||||
|
||||
```yaml
|
||||
version: "3.3"
|
||||
services:
|
||||
homepage:
|
||||
image: ghcr.io/benphelps/homepage:latest
|
||||
container_name: homepage
|
||||
ports:
|
||||
- 3000:3000
|
||||
volumes:
|
||||
- /path/to/config:/app/config # Make sure your local config directory exists
|
||||
- /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations, see alternative methods
|
||||
environment:
|
||||
PUID: $PUID
|
||||
PGID: $PGID
|
||||
```
|
||||
|
||||
### With Docker Run
|
||||
|
||||
```bash
|
||||
docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/benphelps/homepage:latest
|
||||
```
|
||||
|
||||
### Using Environment Secrets
|
||||
|
||||
You can also include environment variables in your config files to protect sensitive information. Note:
|
||||
|
||||
- Environment variables must start with `HOMEPAGE_VAR_` or `HOMEPAGE_FILE_`
|
||||
- The value of env var `HOMEPAGE_VAR_XXX` will replace `{{HOMEPAGE_VAR_XXX}}` in any config
|
||||
- The value of env var `HOMEPAGE_FILE_XXX` must be a file path, the contents of which will be used to replace `{{HOMEPAGE_FILE_XXX}}` in any config
|
Loading…
Add table
Add a link
Reference in a new issue