Skip to content

Quick start

The fastest way to see Punchlist: one container, data in a Docker volume.

docker run -d --name punchlist -p 8080:8080 -v punchlist-data:/data -v punchlist-files:/files \
  registry.gitlab.com/killswitch10/punchlist:latest
docker logs punchlist

The log shows a box like this, once:

============================================================
  Punchlist admin account created
    username: admin
    password: 7mKq...
  Log in and change it. This is shown only once.
============================================================

Open http://localhost:8080, sign in as admin with that password, and choose a new one. A short setup follows (the address people will use, single sign-on if you want it). You can skip it and come back from Admin.

Missed the password?

docker exec punchlist punchlist admin reset-password prints a new one.

Next steps

  • Keep it running properly with Docker Compose.
  • Put it behind HTTPS: browsers only install the app and allow offline use on a secure address (or localhost).
  • Add people under Admin > Users, or let them in with single sign-on.
  • Read First start for what the admin account can do.