Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
The easiest way to install Trellis is to use the pre-built installers described on the project download page.
This page outlines the steps for installing Trellis manually.
Installing as a system service
To install Trellis as a
systemd service on linux,
follow the steps below.
systemd is used by linux distributions such as CentOS/RHEL 7+ and Ubuntu 15+.
Move the unpacked Trellis directory to a location such as
/opt/trellis. If you choose a different location, please update the
./etc/environmentfile as desired (optional).
./etc/config.ymlfile as desired (optional).
Create a trellis user:
$ sudo useradd -r trellis -s /sbin/nologin
- Create data directories. A different location can be used, but then please update
$ sudo mkdir /var/lib/trellis $ sudo chown trellis.trellis /var/lib/trellis
- Install the systemd file:
$ sudo ln -s /opt/trellis/etc/trellis.service /etc/systemd/system/trellis.service
- Reload systemd to see the changes
$ sudo systemctl daemon-reload
- Start the trellis service
$ sudo systemctl start trellis
Running from the command line
For testing, it may be desirable to run Trellis directly from the command line. After unpacking either the ZIP or TAR archive and adjusting the configuration file in
./etc/config.yml, run the following command:
$ ./bin/trellis server ./etc/config.yml
On Windows systems, use the
Check that Trellis is running
To check that trellis is running, check the URL:
Application health checks are available at