lichess-org/lila-gitpod

Lichess development environment

Lichess.org Development Environment

Watch a video demo of how you can use this.

You can use Gitpod (a free online development environment) for contributing. With a single click, it will launch a workspace and automatically:

• Clone the necessary Lichess repositories
• Install all the dependencies
• Seed your database with test data
• Start lila

Read the full Lichess on Gitpod documentation.

Click here to create a workspace:

See the lila-docker repo for the code that runs the workspace and for more information.

lila-gitpod's Issues

Outdated documentation on how to retrieve a list of users

The Getting Started guide recommends running the following command to retrieve a list of users:

docker compose run --rm -v $(pwd)/scripts:/scripts mongodb bash -c \
    "mongosh --host mongodb lichess --file /scripts/mongodb/users.js"

However, this command was removed in October 2023.

Document steps to resolve : remote: error: Your push would publish a private email address.

Maybe we should document this? I say that, since I did spend some time realizing that this is why things failed, and the actual git error is not shown directly in your face. But then again, not sure how many would run into it.

A user could run into it, if they have "Keep my email addresses private" turned on in https://github.com/settings/emails

The fix is to add .env variables in gitpod

It's kinda documented in gitpod here : https://gitpod.io/user/account and you can set the variables here : https://gitpod.io/user/variables So might be fine to not document it in https://lichess-org.github.io/lila-gitpod/contributing/ 🤷

The workspace creation has problems or when it is created the lila lichess will not start

Inspired by the article on lichess:
https://lichess.org/blog/ZUviXRIAACYAVtMm/lichess-development-made-easy-with-gitpod

Version used:
https://gitpod.io/start/#lichessorg-liladocker-cc57v3i3xt3

Browser used:
Firefox 119.0 (64-bit) / Mozilla Firefox Snap for Ubuntu

Case 1 Workspace creation fails completely:

Error Message: "Error: 13 INTERNAL: cannot resolve image: failed to do request: Head "https://registry-1.docker.io/v2/gitpod/workspace-full/manifests/latest": EOF"

_Case 2 lila lichess does not start

Error message: "✘ lila_docker_rs Error 6.4s
Error response from daemon: Get "https://registry-1.docker.io/v2/library/rust/manifests/sha256:666012b6779ebb6be2acb771b8627716662cf699502e734652c4799ae4199691": EOF"

Error with array parameters in query strings

On production, this URL works: https://lichess.org/account/oauth/token/create?scopes[]=challenge:write&scopes[]=puzzle:read&description=Prefilled+token+example

But if you go to the equivalent on a workspace (just changing the hostname), it returns:

Illegal request-target: Invalid input '[', expected query-char, pct-encoded or 'EOI' (line 1, column 35)

The error that shows up in the lila log:

[warn] a.actor.ActorSystemImpl - Illegal request, responding with status '400 Bad Request': Illegal request-target: Invalid input '[', expected query-char, pct-encoded or 'EOI' (line 1, column 35): /account/oauth/token/create?scopes[]=challenge:write&scopes[]=puzzle:read&description=Prefilled+token+example

doesn’t work by default with latest Lichess

(Seems to be caused by lichess-org/lila@01a0a7b.)

I get a lot of unmappable character (0xAB) for encoding US-ASCII errors (with different hex codes) while building the i18n module.

I was able to fix it by modifying the .bloop/i18n.json file. I changed the "project" → "java" → "options" array (which was initally empty) to contain the strings "-encoding", "utf-8", and the project built successfully again! It looked like this:

...
"java": {
    "options": [
        "-encoding", "utf-8"
    ]
},
...