Installing EEVis

Download the latest EEVis release: eevis-docker (latest release)

EEVis runs on your own computer inside a single Docker container. The container holds MySQL, the EEVis web application, and (optionally) nginx. Each time it starts, it fetches the current EEVis source from GitHub and builds it, so you always run the latest version of the application.

1. What you need

macOS or Linux: nothing beyond a terminal. If Docker is missing, the start script offers to install it, and asks before changing anything on your system.
Windows: Git Bash, which comes with Git for Windows. Run every command below in Git Bash; the scripts do not run in Command Prompt or PowerShell. If Docker Desktop is missing, the start script offers to install it.
curl on your PATH. It ships with macOS, most Linux distributions and Git Bash.
An internet connection the first time you start EEVis.

2. Unzip the download

The download is a zip file named eevis-docker-1.0.0.zip. Unzip it wherever you keep software:

macOS: double-click the zip in Finder.
Windows: right-click the zip and choose Extract All.
Linux or any terminal:

unzip eevis-docker-1.0.0.zip

This creates a folder named eevis-docker-1.0.0. Rename it to eevis-docker:

mv eevis-docker-1.0.0 eevis-docker

The folder name matters. Docker names the EEVis database after the folder, so a fixed name keeps your accounts and data when you upgrade to a newer release later.

3. Start EEVis

Open a terminal in the folder and run the start script:

cd eevis-docker
scripts/run.sh

If you get Permission denied (common after extracting on Windows), run bash scripts/run.sh instead.

The script:

checks that Docker and Docker Compose are installed and running, and offers to install or start them if not;
picks a free port, starting at 8080;
builds and starts the container (the first start takes several minutes);
waits for EEVis to respond;
opens EEVis in your web browser.

Log in with user admin and password admin123. To use a different admin account, copy .env.example to .env and edit it before the first start; the admin account is created only once, when the database is new.

4. Stop EEVis

scripts/stop.sh              # stop, keep the database
scripts/stop.sh --wipe-db    # stop and delete the database

5. Upgrade to a new release

Stop EEVis with scripts/stop.sh.
Download and unzip the new release.
Replace the contents of your eevis-docker folder with the new files, keeping your .env file, and start EEVis again.

Optional: web mode

To serve EEVis through nginx, closer to a real deployment, start it with:

scripts/run.sh web

Windows notes

If Docker Desktop is not installed, the start script offers to install it with winget. After it installs, log out and back in (or restart) if Windows asks you to, then run scripts/run.sh again.
Docker Desktop needs WSL2 enabled. If Docker Desktop does not finish starting, open it, complete any setup prompts, and run scripts/run.sh again.

Full technical details are in the eevis-docker repository.