FedResDa Pod

FedResDa Pod is a Solid Pod deployment for querying FEDerated RESearch DAta.

• Docker with Compose plugin (docker compose)
• A hostname and DNS record pointing to the server (for public deployments)
• Host storage path for persistent data (HOST_DATA_DIR)

Download and start from a release artifact:

wget https://github.com/SetMeld/fedresda-node/releases/latest/download/fedresda-node-deploy-latest.tar.gz
tar -xzf fedresda-node-deploy-latest.tar.gz
cd fedresda-node-deploy
./deploy.sh init
# edit config.env
./deploy.sh up

Or build the package from source:

npm install
npm run build
npm run deploy:package

This creates build/fedresda-node-deploy-<version>.tar.gz.

Required keys validated by deploy.sh:

• BASE_URL (public app URL, for example https://pod.example.org)
• HOST_DATA_DIR (persistent host directory)
• NODE_HOST_PORT
• TRUST_PROXY
• TRIPLESTORE_MODE (bundled or external)
• PROXY_MODE (nginx, external, or none)
• TLS_MODE (none, custom, or letsencrypt)

Mode-specific keys:

• TRIPLESTORE_MODE=external -> set EXTERNAL_TRIPLESTORE_URL
• TLS_MODE=custom -> set CUSTOM_CERT_FULLCHAIN and CUSTOM_CERT_PRIVKEY
• TLS_MODE=letsencrypt -> set SSL_EMAIL
• PROXY_MODE=nginx -> optional NGINX_CLIENT_MAX_BODY_SIZE (default 1g, e.g. 2g)

Set TRUST_PROXY to match your network path so Express correctly uses forwarded headers:

• unset/empty: default behavior (do not trust forwarded headers)
• true or 1: trust proxy
• false or 0: explicitly do not trust
• numeric value: trust that many proxy hops

When proxying (Nginx/F5/etc.), ensure these headers are passed:

• X-Forwarded-For
• X-Forwarded-Proto

If PROXY_MODE=external, disable bundled Nginx and configure your own proxy similarly.

./deploy.sh status
./deploy.sh logs
./deploy.sh restart
./deploy.sh down
./deploy.sh renew-certs

renew-certs is only valid with PROXY_MODE=nginx and TLS_MODE=letsencrypt.

Upgrade in place so config.env stays where it is:

# from the server, while in the existing deploy directory
cd fedresda-node-deploy
cp config.env config.env.backup

cd ..
wget https://github.com/SetMeld/fedresda-node/releases/latest/download/fedresda-node-deploy-latest.tar.gz
tar -xzf fedresda-node-deploy-latest.tar.gz --strip-components=1 -C fedresda-node-deploy

cd fedresda-node-deploy
./deploy.sh up

Notes:

• deploy.sh up now auto-adds any missing config keys from config.env.example during upgrades.
• Keep HOST_DATA_DIR unchanged so existing pod data remains available.
• If needed, restore your backup with cp config.env.backup config.env, extract a previous release tarball, and run ./deploy.sh up.

• Open your pod URL (or http://localhost:3000/ in local dev).
• Sign up and create your pod/account.
• Set an SSH key in the UI if you need Git-based integration workflows.

In local development, data is stored under data/, including:

• data/.internal/integration-git
• data/.internal/integration-code
• data/.internal/integration-meta
• data/.internal/authorized_keys

Example push target in dev:

git remote add origin ssh://git@localhost:2229/my_repo_name.git
git push -u origin main

• server (@fedresda/server): Community Solid Server integration and API layer
• ui (@fedresda/ui): React/Expo UI app
• types (@fedresda/types): shared generated/schema types

npm install
npm run dev

• npm run dev / npm run dev:server / npm run dev:ui
• npm run build / npm run build:types / npm run build:server / npm run build:ui
• npm run graph
• npm run deploy:package
• npm run version:get
• npm run version:set <version>
• npm run version:bump <major|minor|patch|prerelease>

Pushes to main run .github/workflows/release-deploy-package.yml and publish:

• fedresda-node-deploy-latest.tar.gz
• fedresda-node-deploy-<version>.tar.gz

For a specific release:

wget https://github.com/SetMeld/fedresda-node/releases/download/<tag>/fedresda-node-deploy-<version>.tar.gz

• node-app (Community Solid Server)
• optional triplestore (bundled Blazegraph)
• optional nginx
• certbot (invoked by script for Let's Encrypt issue/renew)

MIT