RethinkDB Old Admin

This repo has the "old" RethinkDB admin UI. That's possibly the "current" admin UI, but a new one is under development.

The "old" admin UI originally shared a repository with the main RethinkDB repository, the one at https://github.com/rethinkdb/rethinkdb .

This repository is formed from RethinkDB's main repo, branch v2.4.x, by removing everything that isn't admin UI-related, while keeping the build system. That means the following got removed:

• The C++ source code (except for src/rdb_protocol/ql2.proto)

• Some library packages in mk/support/pkg that are included in the C++ executable (for example, v8, gtest, zlib, re2).

• Drivers other than the JavaScript driver

• Test code (in ./tests)

• Other miscellanea

The web_assets.cc file still gets generated in the same place: In src/gen/web_assets.cc.

Usage

To generate src/gen/web_assets.cc, run the following:

./configure --fetch all

make clean
make -j8 generate

To generate a web_assets.cc for a specific RethinkDB version like 1.2.3, you might want to try

cd /rethinkdb    # see "canonical location" instructions below
make clean
make PVERSION=1.2.3 -j8 generate

It is IMPORTANT that you clean and double-check the rethinkdb-version value in src/gen/web_assets.cc after generating. (The build system now greps the web_assets.cc file for you so you can visually inspect the generated value.)

Once src/gen/web_assets.cc is built, you can copy the file into your rethinkdb repository, replacing the existing one at the same location, src/gen/web_assets.cc. Then, if appropriate, commit that version.

If committing, your web assets should be generated from a repo located at the "canonical location", which is /rethinkdb. The generation process emits some absolute paths; hence this minimizes diffs and avoids leaking your personal directory information. See #7136 . A fix for this problem is welcome; this is a lazy workaround.

Development Process

To develop the "old" admin UI, you just need an existing RethinkDB binary. You don't have to build it yourself. Suppose this repository is checked out at ~/rethinkdb-old-admin. Then run the following:

cd ~/rethinkdb-old-admin
make web-assets
make web-assets-watch

That will automatically update ~/rethinkdb-old-admin/build/web_assets when you make changes in ~/rethinkdb-old-admin/admin. Then, in another terminal, run:

rethinkdb --web-static-directory ~/rethinkdb-old-admin/build/web_assets

Now you can work on the web UI in ~/rethinkdb-old-admin/admin/ and semi-instantly view the results in a web browser.

Beware: RethinkDB's server won't serve any file outside of the whitelist of files that were listed in its generated web_assets.cc. You will see console log messages if that occurs. If you add new files, you will need to regenerate web_assets.cc and recompile the RethinkDB server.

Then, once you're satisfied with your changes, interrupt the make web-assets-watch with Ctrl+C and use make generate to create your web_assets.cc, as described in the Usage section above.

System Requirements

This is known to work on Debian Bullseye (with python-is-python3), Ubuntu Focal (20.04), and Ubuntu Jammy (22.04).