Skip to main content
 

How can we help?

Search

Standard Stack (GitHub only)

  • Updated

If you use Standard Stack, you have the option to run a containerized version of Acrolinx for GitHub. That way, you can maintain the same level of control in Acrolinx for GitHub as you do with Standard Stack. You’ll find the container images for Acrolinx for GitHub in your Acrolinx download area.

Note

If you want to host and maintain your own installation of the Acrolinx Platform, there are extra administrative steps that you should know about. Visit our Acrolinx for Standard Stack documentation to learn more about the technical details of maintaining an Acrolinx installation.

To start Acrolinx for GitHub with Standard Stack, you can use the following command:

sudo docker run --user 2734:2734 -p 127.0.0.1:PORT:PORT -v LOCALPATHTOCONFIGFILE:/etc/githubhook/config.edn:ro IMAGELOCATION --config /etc/githubhook/config.edn ARGS

  • PORT is the TCP/IP port where you start Acrolinx for GitHub. The default value is 9779.

  • LOCALPATHTOCONFIGFILE is the local path to the configuration file. If config.edn is in the current directory on the host, use $PWD/config.edn.

  • IMAGELOCATION is the address of the container image in the container registry.

  • ARGS is for any further arguments for Acrolinx for GitHub like--baseline.

Tip

If you prefer, you can use --version in the beginning to test the setup.

For example:

sudo docker run --user 2734:2734 -e ACROLINX_LOGGING_MODE=structured -p 127.0.0.1:9779:9779 -v $PWD/config.edn:/etc/githubhook/config.edn:ro IMAGELOCATION --config /etc/githubhook/config.edn --baseline

In this example, the environment variable ACROLINX_LOGGING_MODE is set to produce JSON-based logs. You can remove it when you set up Acrolinx for GitHub or if you prefer not to use structured logging.