---

Table of Contents

• Features
• Quick Start
• Configuration
• Styling
• Development

Features

• yaml configuration file
• Search
• Application Grouping
• Bookmarks
• CSS Theme Customization

Quick Start

Using Docker

To start container:

docker run -d \
  -p 8080:8080 \
  -v </your/local/assets/>:/www/assets \
  --restart=always \
  ghcr.io/captain-otter/yet-another-homepage

Using docker-compose

Add following to your docker-compose.yml file:

yet-another-homepage:
    image: ghcr.io/captain-otter/yet-another-homepage:release
    container_name: yet-another-homepage
    volumes:
      - ${DATADIR}/appdata/yet-another-homepage/assets/:/www/assets
    environment:
     # Needed for files to have correct access rights. Remember to change to correct values.
      - UID=1000
      - GID=1000
    ports:
      - 8080:8080
    restart: unless-stopped

then run the container with:

docker-compose up -d