Apollo API v2

Backend and device management service for Apollo systems. In production this repo is installed on the device at /opt/apolloapi, runs the API directly with Node.js, builds the UI on-device, and manages miner/node/solo services through systemd.

Local Development

Requirements

• Node.js 21.x
• Yarn

Install

yarn

Run

yarn dev

On first start the app will:

1. Create .env in the repo root if it does not exist.
2. Set DATABASE_URL to futurebit.sqlite.
3. Generate APP_SECRET.
4. Run pending SQLite migrations.
5. Start the API from src/init.js.

The development entrypoint is the API only. The production UI lives in the separate apolloui-v2 repo and is installed on devices under /opt/apolloapi/apolloui-v2.

Production Install

The old cross-build / tarball workflow is obsolete. Current devices have enough RAM to install dependencies and build the UI directly on the device.

Main installer

For a standard device image install from a checked out repo, use:

sudo bash backend/utils/image_install

For a one-command install directly from the main branch, use:

curl -fsSL https://raw.githubusercontent.com/jstefanop/apolloapi-v2/main/backend/utils/image_install | sudo bash

These installers perform the full device setup:

• Install required Debian packages.
• Create the futurebit user.
• Clone apolloapi-v2 into /opt/apolloapi.
• Clone apolloui-v2 into /opt/apolloapi/apolloui-v2.
• Install NVM, Node 21.6.2, and Yarn.
• Create .env files for the API and UI.
• Run yarn for the API.
• Run yarn install and yarn build for the UI on-device.
• Install bundled miner, node, and ckpool binaries for the device architecture.
• Copy systemd unit files into /etc/systemd/system.

Alternate installer

There is also a repo installer at:

sudo bash backend/install-v2

It follows the same general flow and supports:

sudo bash backend/install-v2 dev
sudo bash backend/install-v2 dev <branch>

Use the backend/utils/ installers for current image/device setup unless you specifically need the older install-v2 path.

Production Updates

For image/device installs that were originally set up with image_install, use:

sudo bash backend/utils/image_update

For repo-managed updates, use:

sudo bash backend/update

Notes:

• These update scripts assume the production install lives at /opt/apolloapi.
• They stop production services, refresh code, reinstall dependencies, rebuild the UI on-device, refresh bundled binaries, and reload systemd.
• They are not safe for preserving local uncommitted changes inside /opt/apolloapi; some paths use git reset --hard.

Production Services

The production install copies the following units into /etc/systemd/system:

• apollo-api.service
• apollo-ui-v2.service
• apollo-miner.service
• node.service
• ckpool.service
• rc-local.service
• swap.service on image installs that enable swap

Common commands

Check status:

sudo systemctl status apollo-api apollo-ui-v2 apollo-miner node ckpool

Restart the API and UI:

sudo systemctl restart apollo-api apollo-ui-v2

Control miner, node, or solo pool individually:

sudo systemctl start apollo-miner
sudo systemctl stop node
sudo systemctl restart ckpool

Enable a service at boot:

sudo systemctl enable apollo-api

Reload unit files after changing service definitions:

sudo systemctl daemon-reload

Service startup order

The shipped units currently start in this order:

• rc-local.service
• apollo-api.service
• apollo-ui-v2.service
• node.service
• ckpool.service

apollo-miner.service also starts after the network and rc-local.service.

Logs

Use journalctl for service logs:

sudo journalctl -u apollo-api -f
sudo journalctl -u apollo-ui-v2 -f
sudo journalctl -u node -f
sudo journalctl -u apollo-miner -f
sudo journalctl -u ckpool -f

Runtime Layout

Production installs expect these paths:

• API repo: /opt/apolloapi
• UI repo: /opt/apolloapi/apolloui-v2
• SQLite DB: /opt/apolloapi/futurebit.sqlite
• API env file: /opt/apolloapi/.env
• Node config: /opt/apolloapi/backend/node/
• ckpool config/logs: /opt/apolloapi/backend/ckpool/

Networking / System Utilities

• NetworkManager CLI is available via nmcli.
• Firewall setup is handled by backend/firewall and is wired into boot via rc.local.
• Tor is installed by the production installers and kept disabled until enabled by the system/app flow.

Uninstall

To remove the production install:

sudo bash backend/uninstall-v2