Lichess Docker Container

Usage

1. Clone or download this repo and cd into it
2. If you're on Windows, make sure all .sh files have Unix line endings (i.e. just LF). Depending on your git configuration, they might be converted to Windows file endings (i.e. CLRF) which will not work. This may also apply to lila scripts like ./lila or ./ui/build later on.
3. Build the image: docker build --tag lichess .
4. Clone or downlod lila and lila-ws. It's assumed they are placed in $HOME/dev/lichess/{lila,lila-ws}. If that's not the case you'll have to modify docker-run.sh or the command below.
5. Create and start the container:

Either run ./docker-run.sh or the following command (make sure to adjust $HOME/dev/lichess if you cloned lila and lila-ws to a different directory):

docker run \
    --mount type=bind,source=$HOME/dev/lichess,target=/home/lichess/projects \
    --publish 9663:9663 \
    --publish 9664:9664 \
    --publish 8212:8212 \
    --name lichess \
    --interactive \
    --tty \
    lichess

If you are starting the container directly from Windows, you can use docker-run.bat instead (again, make sure to adjust the mount point to the actual directory where lila and lila-ws are located). However, I strongly recommend running Docker from WSL 2 and placing lila and lila-ws in the WSL 2 file system since that will significantly speed up compilation.

6. The contianer will automatically start redis and mongo but won't build or run any lila services, so you will have to do that manually. I generally create two additional sessions using docker exec -it lichess bash in new terminal windows:
   • One to run lila-ws using cd ~/projects/lila-ws and sbt run.
   • Another to build UI stuff i.e. compile SCSS and TypeScript to CSS and JavaScript in cd ~/projects/lila/ui: - ./build to build all the UI stuff. You should do this at least once the first time after cloning the project and probably again every time after pulling major changes. - ./build dev css to only build SCSS - cd analyse and yarn dev to build just the analyse module and similarly for other modules - And I also use this terminal for other miscellaneous stuff like accessing the db via mongo lichess.
   • And ofc, the main session will be used to run lila itself using ./lila run. Before the first run, you should also run mongo lichess bin/mongodb/indexes.js to create db indices.
   • You should also read the Lichess Development Onboarding guide on the Lichess GitHub wiki for additional instructions on seeding the db, gaining admin access, or running suplementary services like fishnet for server analysis or playing vs Stockfish

Note, that with the run command above (or docker-run.sh) or the start command below, the container will be stopped (but not deleted) when the main session exits, so that session always has to be kept alive and ideally should be terminated last.

Useful commands

• Stop the Docker container: docker stop lichess
• Restart the Docker container and attach to it: docker start lichess --attach --interactive
• Open a second shell in the running container: docker exec -it lichess bash
• Remove the Docker container (e.g. to mount a different volume): docker rm lichess