/lila-db-seed

Minimum database data for development on ornicar/lila

Primary LanguagePythonMIT LicenseMIT

Database data for development on ornicar/lila

Usage:

mongorestore dump

Contents:

  • 3000 puzzles (also see this full puzzle DB in CSV format)
  • 2036 puzzle paths, required by lila to find the puzzles
  • 3000 games from which the puzzles were made, required by lila to use the puzzles
  • lots of other stuff including users & mods. see below

Populate your database:

python3.9+ and the pymongo module are both required. If you don't have python3, use your package manager or the downloads page to install it, then get pip3 and pymongo with command line:

python -m ensurepip --upgrade
# NOTE - On windows it might be "py -m ensurepip --upgrade"
pip3 install pymongo

The lila-db-seed/spamdb/spamdb.py script can do a few things. Usage help:

python3 spamdb/spamdb.py --help

Usually, the script will generate a new set of data from inputs in the provided arguments as well as the spamdb/data directory. This data will be merged into your running mongodb instance at 127.0.0.1:27071 by default. To customize connection details use the --uri argument. Set the password for your users with the --password flag (otherwise they will default to "password"). Set the default background in user prefs with --user-bg (default is dark mode, use 400 for transparency). For other options see spamdb.py --help. Add, remove, or modify entries to the various .txt files in the data directory if you want to customize fluffy stuff.

Do consider editing uids.txt to give the mod users different passwords than the default if your dev instance will be exposed to others.

Special users:

  • lichess - ROLE_SUPER_ADMIN # check out the mod UI if you haven't seen it, very cool!
  • admin - ROLE_ADMIN
  • shusher - ROLE_SHUSHER
  • cheat-hunter - ROLE_CHEAT_HUNTER
  • timeout-mod - ROLE_TIMEOUT_MOD
  • puzzle-curator - ROLE_PUZZLE_CURATOR
  • api-hog - ROLE_API_HOG (this guy is useful for api testing, both server and clients)
  • troll - marked as troll
  • bot - marked as bot
  • kid - they're just children, how could you checkmate children?
  • wide - 20 W's in visible username, WGM title, and a patron to test css formatting for extremely wide usernames.
  • and assorted others, student, coach, see spamdb/modules/user.py

Normal users:

The normal users have all the data. This includes notifications, ratings, follows, game histories, activity, timelines, blogs, forums, teams, tournaments. Their usernames can be found and customized in data/uids.txt. Specify user/password to set individual passwords

Caveats:

There are no indices for game or forum search yet. This will be fixed never/soon.