avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-01-09 17:31:03 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a928c8e9e2df48fd426e6f479bf1d55fd2ea2f4d
hassio-addons/grav/README.md
Alexandre a928c8e9e2 Embed env_vars guidance in docs
2025-11-06 16:50:01 +01:00

4.7 KiB
Raw Blame History

Home assistant add-on: Grav

Donate Donate

Version Ingress Arch

Codacy Badge GitHub Super-Linter Builder

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

Stargazers repo roster for @alexbelgium/hassio-addons

downloads evolution

About

Grav is a free software, self-hosted content management system (CMS) written in the PHP programming language and based on the Symfony web application framework. It uses a flat file database for both backend and frontend. This addon is based on the docker image https://github.com/linuxserver/docker-grav

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.

  1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA) Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.
  2. Install this add-on.
  3. Click the Save button to store your configuration.
  4. Set the add-on options to your preferences
  5. Start the add-on.
  6. Check the logs of the add-on to see if everything went well.
  7. Open the webUI and adapt the software options

Configuration

Use the add-on env_vars option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.

Webui can be found at http://homeassistant:9191. Configurations can be done through the app webUI, except for the following options.

Setup Steps

  1. Access the web interface after starting the addon
  2. Follow the Grav setup wizard for initial configuration
  3. Install themes/plugins through the admin panel
  4. Custom themes can be placed in /share/grav/www/user

Options

Option Type Default Description
PGID int 1000 Group ID for file permissions
PUID int 1000 User ID for file permissions
TZ str Timezone (e.g., Europe/London)

Example Configuration

PGID: 1000
PUID: 1000
TZ: "Europe/London"

Adding Themes/Skeletons

Place custom themes and skeletons in /share/grav/www/user/ directory:

  • Themes: /share/grav/www/user/themes/
  • Plugins: /share/grav/www/user/plugins/
  • Pages: /share/grav/www/user/pages/

Support

Create an issue on github

Illustration

illustration