This is a fork of gethomepage/homepage

DISCLAIMER: you shouldn't clone my fork, it'll never replace the excellent work of the Homepage team. My code may have vulnerabilities and some of the features may not be maintained. Use it as inspiration. You can copy my code without mentioning me.

Added features

• Widget for Cronicle (doc)
• Widget for SilverBullet (doc)
• Enable HTML rendering in services description with renderDescriptionHtml: true (doc)

Build the image to Github container registry

Follow these steps to build an the docker image to Github container registry, for a Raspberry Pi 4.

1. Enable builder:

   docker buildx create --name rpi4-builder --use`

2. Install QEMU to emulate arm64:

   docker run --privileged --rm tonistiigi/binfmt --install all`

3. Check the builder:

   docker buildx inspect --bootstrap

   You should see "Platforms: [...] linux/arm64 [...]"
4. Create a Github PAT (classic) with the following scopes: write:packages, read:packages, and delete:packages and copy the token to somewhere safe (you won't see it again)
5. Login to Github container registry:

   export CR_PAT=<YOUR_COPIED_TOKEN>
   echo $CR_PAT | docker login ghcr.io -u <YOUR_USERNAME> --password-stdin

6. Build and push the image:

   docker buildx build --no-cache --platform linux/arm64 -t ghcr.io/<YOUR_USERNAME>/<YOUR_REPO_NAME>:latest --push .

7. In the server (Raspberry Pi 4), connect to Github container registry:

   export CR_PAT=<YOUR_COPIED_TOKEN>
   echo $CR_PAT | docker login ghcr.io -u <YOUR_USERNAME> --password-stdin

8. Use this docker compose file:

   services:
     homepage:
       image: ghcr.io/<YOUR_USERNAME>/<YOUR_REPO_NAME>:latest
       container_name: homepage
       environment:
         PUID: 1000 # optional, your user id
         PGID: 1000 # optional, your group id
         # HOMEPAGE_ALLOWED_HOSTS: homepage.example.com  # (Optional) add this if you want to access the homepage from a different host
       volumes:
         - ./config:/app/config # Make sure your local config directory exists
         - /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations
       restart: always

9. Start the container:

   docker compose up -d

Installation

The docker compose file has some modifications as the docker image must be built.

1. git clone git@github.com:paulchaum/homepage.git paulchaum-gethomepage
2. cd paulchaum-gethomepage
3. mkdir config/
4. nano docker-compose.yml
5. Paste this in the docker-compose.yml:

   services:
     homepage:
       build: .
       container_name: homepage
       environment:
         PUID: 1000 # optional, your user id
         PGID: 1000 # optional, your group id
       volumes:
         - ./config:/app/config # Make sure your local config directory exists
         - /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations
       restart: unless-stopped

Updated documentation

The documentation is updated with the new widget. You can deep dive in docs, or you can build the doc by following the guide on Documentation.

---

A modern, fully static, fast, secure fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.

       

Homepage builds are kindly powered by DigitalOcean.

Features

With features like quick search, bookmarks, weather support, a wide range of integrations and widgets, an elegant and modern design, and a focus on performance, Homepage is your ideal start to the day and a handy companion throughout it.

• Fast - The site is statically generated at build time for instant load times.
• Secure - All API requests to backend services are proxied, keeping your API keys hidden. Constantly reviewed for security by the community.
• For Everyone - Images built for AMD64, ARM64.
• Full i18n - Support for over 40 languages.
• Service & Web Bookmarks - Add custom links to the homepage.
• Docker Integration - Container status and stats. Automatic service discovery via labels.
• Service Integration - Over 100 service integrations, including popular starr and self-hosted apps.
• Information & Utility Widgets - Weather, time, date, search, and more.
• And much more...

Docker Integration

Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the Docker Service Discovery page for more information.

Service Widgets

Homepage also has support for hundreds of 3rd-party services, including all popular *arr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission, qBittorrent, Deluge, Jackett, NZBGet, SABnzbd, etc. As well as service integrations, Homepage also has a number of information providers, sourcing information from a variety of external 3rd-party APIs. See the Service page for more information.

Information Widgets

Homepage has built-in support for a number of information providers, including weather, time, date, search, glances and more. System and status information presented at the top of the page. See the Information Providers page for more information.

Customization

Homepage is highly customizable, with support for custom themes, custom CSS & JS, custom layouts, formatting, localization and more. See the Settings page for more information.

Getting Started

For configuration options, examples and more, please check out the homepage documentation.

Security Notice 🔒

Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.

With Docker

Using docker compose:

services:
  homepage:
    image: ghcr.io/gethomepage/homepage:latest
    container_name: homepage
    environment:
      HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts
      PUID: 1000 # optional, your user id
      PGID: 1000 # optional, your group id
    ports:
      - 3000:3000
    volumes:
      - /path/to/config:/app/config # Make sure your local config directory exists
      - /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations
    restart: unless-stopped

or docker run:

docker run --name homepage \
  -e HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev \
  -e PUID=1000 \
  -e PGID=1000 \
  -p 3000:3000 \
  -v /path/to/config:/app/config \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  --restart unless-stopped \
  ghcr.io/gethomepage/homepage:latest

From Source

First, clone the repository:

git clone https://github.com/gethomepage/homepage.git

Then install dependencies and build the production bundle:

pnpm install
pnpm build

If this is your first time starting, copy the src/skeleton directory to config/ to populate initial example config files.

Finally, run the server in production mode:

pnpm start

Configuration

Please refer to the homepage documentation website for more information. Everything you need to know about configuring Homepage is there. Please read everything carefully before asking for help, as most questions are answered there or are simple YAML configuration issues.

Development

Install NPM packages, this project uses pnpm (and so should you!):

pnpm install

Start the development server:

pnpm dev

Open http://localhost:3000 to start.

This is a Next.js application, see their documentation for more information.

Documentation

The homepage documentation is available at https://gethomepage.dev/.

Homepage uses Material for MkDocs for documentation. To run the documentation locally, first install the dependencies:

pip install -r requirements.txt

Then run the development server:

mkdocs serve # or build, to build the static site

Support & Suggestions

If you have any questions, suggestions, or general issues, please start a discussion on the Discussions page.

Troubleshooting

In addition to the docs, the troubleshooting guide can help reveal many basic config or network issues. If you're having a problem, it's a good place to start.

Contributing & Contributors

Contributions are welcome! Please see the CONTRIBUTING.md file for more information.

Thanks to the over 200 contributors who have helped make this project what it is today!

Especially huge thanks to @shamoon, who has been the backbone of this community from the very start.