Install Gruxi using a Debian package

Gruxi currently provides packages for Debian-based Linux distributions. If you are using a different platform, use the prebuilt binaries or Docker.

By installing the Debian package, you get the same prebuilt binaries under the hood, but with added convenience, integration with systemd for service management, and security hardening. This is the recommended installation method for Debian-based Linux users who want easy installation and service management.

1. Download the release

You can download the latest release from GitHub Releases. Download the .deb package that matches your system architecture (e.g., amd64 for x86-64 systems, arm64 for ARM-based Linux).

2. Install the package

Use sudo dpkg -i <gruxi_deb_filename>.deb to install the package.

This does the following:

• Installs the Gruxi binary to /usr/bin/gruxi
• Creates a systemd service file to run Gruxi as a service
• Sets up necessary permissions and directories for Gruxi to run securely as a non-root user
  • Creates a dedicated user and group for Gruxi called gruxi
  • Creates a log directory at /var/log/gruxi with appropriate permissions
  • Creates a data directory at /var/lib/gruxi with appropriate permissions
  • Creates default web content and admin portal content in /usr/share/gruxi with appropriate permissions
• Enables and starts the Gruxi service automatically after installation

3. Verify the service

After installation, you can manage the Gruxi service using sudo systemctl commands, such as:

• sudo systemctl status gruxi - Check the status of the Gruxi service and view logs
• sudo systemctl start gruxi - Start the Gruxi service
• sudo systemctl stop gruxi - Stop the Gruxi service
• sudo systemctl restart gruxi - Restart the Gruxi service

Get the latest log with sudo journalctl -u gruxi -f to see the output of the Gruxi service, including the admin password printed on first run. This will also be in the log file at /var/log/gruxi/gruxi.log if you want to check it there.

4. Verify installation

Open http://localhost to see the default Gruxi page.

5. Configure installation

Open https://localhost:8000 and log in with the user admin and the password printed to the server output on first run (by running sudo journalctl -u gruxi -f). Save it, as it will not be shown again.

Next step

You now have a working Gruxi instance running on your system or server.

Next, learn how to configure Gruxi.