Installing PropelAuth BYO

PropelAuth BYO has only one dependency: a Postgres database. For developing locally, we’re going to use docker compose to run both the database and the PropelAuth BYO sidecar.

1. Clone the repo with config files and docker compose setup:

   git clone git@github.com:PropelAuth/byo-config-template.git
   

   • Directorybyo-config-template/
     • .env.example
     • compose.yaml
     • Directoryconfigs/
       • sso_config.jsonc
       • scim_config.jsonc
       • session_config.jsonc
       • …and other configs

2. Copy the .env.example file to a new .env file and update the BYO_LICENSE_KEY variable with your PropelAuth BYO license key. You can get a license key by going to the PropelAuth Dashboard.

   cp .env.example .env
   

   BYO_LICENSE_KEY="pa_..."
   
   INITIAL_OWNER_USERNAME="root"
   

3. Run docker compose to start the Postgres database and PropelAuth BYO sidecar:

   docker compose -f compose.yaml up -d
   

   This will start both the Postgres database and the PropelAuth BYO sidecar. The sidecar will automatically connect to the database and run any necessary migrations.

4. To verify everything is running correctly, navigate to http://localhost:2884 and you should see a login page:

5. Log in with the INITIAL_OWNER_USERNAME (from your .env file, default is root) and the password thispasswordistemporary. You will be prompted to change your password after logging in.