DocumentationLogChimp Documentation
Install

Docker

Install LogChimp using Docker Compose

The Docker Compose Community is officially maintained by the core team.

If Docker or Docker Compose is not installed on your machine/server, refer to the Docker Compose installation docs.

You can kick-start your LogChimp site in 2 easy steps.

Step 1. Download docker-compose.yml file

Run the following command to download the docker-compose.yml file in your current directory.

curl -L -o docker-compose.yml
https://raw.githubusercontent.com/logchimp/logchimp/refs/heads/master/docker/community/docker-compose.yml -o .env
https://raw.githubusercontent.com/logchimp/logchimp/master/docker/community/.env.example

Step 2. Update .env file

Update the values in .env file.

Warning

You will need to set-up SMTP configuration to let your users get emails to reset password, account verification, notifications and more.

You can refer to Environment Variables page to see full list of variables along with its description and default values.

Step 3. Run LogChimp using Docker Compose

docker compose -f ./docker-compose.yml --env-file ./.env up -d

After running these commands successfully, you should be able to access LogChimp at http://localhost:3000.

Your LogChimp site is ready to accept your customers' feedback with ease. 🎉

Next steps

The next step is to learn how to use LogChimp.

Resources

  • LogChimp Docker images:
  • APIs - link
  • Theme - link