Deploy from Source

The App Setup

0. Prerequisites

You'll need git and Node.js 22 or newer installed. If you're using NVM you can run nvm use to download and use the version pinned in .nvmrc

1. Get the code and install dependencies

git clone https://github.com/your-org/domain-locker.git
cd domain-locker
npm install

3. Configure the environment

If you're using SQLite, then no environmental variables needed ๐Ÿ™‚ The database is created at ./data/domain-locker.db on first use (or set DL_SQLITE_PATH to put it somewhere else).

If you do need to set variables, then create a .env file in the root of the project. You can view the full list of environmental variables, or start from the .env.sample as a starting point. You have to restart the app for changes to env vars to take affect.

touch .env

4. Build the app

npm run build

5. Start the app

node dist/analog/server/index.mjs

6. Access the app

Visit http://localhost:3000 in your browser to access the app.

Set PORT to serve it somewhere else


The Database Setup

SQLite is recommended, since it needs no additional setup.

During development, you can skip the database setup, and connect to our hosted dev db instance, by using these environment variables. This is NOT suitable for production.

Hey there! ๐Ÿ‘‹

I hope you're finding Domain Locker useful. If you'd like to support my work, consider becoming a sponsor on GitHub Sponsors. Every contribution however small is greatly appreciated and helps me keep these tools running and open source.
Either way, thanks for being hereโ€”you're awesome! ๐Ÿš€