Installing from Source

Get the Source

Clone the repository together with its submodule, core, which holds the shared Maven parent of the build. Use the tag of the release you want to build; release tags start with v. Without --branch you get the development branch main, which is not a release.

git clone --branch <release-tag> --recurse-submodules https://github.com/repsyio/repsy.git
cd repsy

The submodule is configured with an SSH address ([email protected]:repsyio/repsy-core.git). If you have no SSH key for GitHub, tell Git to use HTTPS for it:

git -c url."https://github.com/".insteadOf="[email protected]:" clone --branch <release-tag> --recurse-submodules https://github.com/repsyio/repsy.git

Build the Backend

Install the shared modules first, then build the backend with everything it needs:

mvn -f core/pom.xml install -DskipTests
mvn install -pl repsy-backend -am -DskipTests -DskipITs

-DskipITs matters. Without it the build also runs the integration tests, which start a PostgreSQL container and need a running Docker daemon.

The result is one executable jar, repsy-backend/target/repsy-backend.jar.

Build the Web Panel

cd repsy-frontend
pnpm install --frozen-lockfile --ignore-scripts
pnpm run gen:api
pnpm run build:prod
cd ..

gen:api generates the client of Repsy’s panel API from the specification in the backend. The build writes the panel to repsy-frontend/dist/panel-frontend/browser.

Put the Application Together

Repsy serves the panel from a directory named static in its working directory. Create a directory to run it from and copy both results into it. The location is up to you; /opt/repsy is used here.

mkdir -p /opt/repsy
cp repsy-backend/target/repsy-backend.jar /opt/repsy/app.jar
cp -r repsy-frontend/dist/panel-frontend/browser /opt/repsy/static

The panel finds the addresses of the API and of the package protocols in static/assets/static-env.js. It contains the placeholders __API_BASE_URL__ and __REPO_BASE_URL__, which the Docker image replaces when it starts. If you leave them, the panel uses http://localhost:8080 for the API and http://localhost:9090 for the client configuration it shows, which is right on your own machine only. Otherwise replace them, with an empty API address if the panel and the API are reached under the same address:

sed -i \
  -e "s|__API_BASE_URL__||g" \
  -e "s|__REPO_BASE_URL__|https://repo.example.com|g" \
  /opt/repsy/static/assets/static-env.js

Use the same address for the REPO_BASE_URL variable in the next step: the panel takes it from this file, while the npm registry takes it from the variable.

Run It

Create the directory for the data and make it writable for the user who runs Repsy. Then set the configuration in environment variables and start the jar from its own directory. With the embedded H2 database:

mkdir -p /var/lib/repsy
cd /opt/repsy
export DB_URL='jdbc:h2:file:/var/lib/repsy/repsy;MODE=PostgreSQL;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE'
export STORAGE_BASE_PATH=/var/lib/repsy/storage
export ADMIN_INITIAL_PASSWORD=ChangeMe123
export REPO_BASE_URL=https://repo.example.com
export OS_APP_JWT_SECRET="$(openssl rand -base64 32)"
java -jar app.jar

Or with PostgreSQL 18, where the database and the user repsy already exist and the user owns the database:

mkdir -p /var/lib/repsy
cd /opt/repsy
export DB_URL=jdbc:postgresql://localhost:5432/repsy
export DB_USERNAME=repsy
export DB_PASSWORD=<database-password>
export STORAGE_BASE_PATH=/var/lib/repsy/storage
export ADMIN_INITIAL_PASSWORD=ChangeMe123
export REPO_BASE_URL=https://repo.example.com
export OS_APP_JWT_SECRET="$(openssl rand -base64 32)"
java -jar app.jar

Save the OS_APP_JWT_SECRET value somewhere and set the same one on every start, otherwise everybody has to sign in again after each restart. Repsy creates the directory of STORAGE_BASE_PATH and the folders for each package type in it itself.

Sign In

Repsy needs a few seconds to start. Then open http://localhost:8080 and sign in as admin with the password you set. Package clients connect to port 9090.