Installing

An aeppic server consists of two parts. The actual services required and the dataset within that instance.

The primary service required is the aeppic-server service which can be configured and exposes the webserver apis.

Installing service via npx

Given a node.js runtime environment (^16.13.0)

npx @aeppic/install-server [--token=<ACCESS_TOKEN>] [--data=<DATA_PATH>] [<TAG|SEMVER>]

--token is the unique access token required to access the repository server --version declares the version to install (can only be a newer version)

--data can be left off during subsequent updates but specifies the absolute path to the primary data storage folder

[<TAG|SEMVER>] is an optional parameter. It defaults to stable

Declaring parameters as environment variables also works e.g. AEPPIC_INSTALL_VERSION, AEPPIC_INSTALL_DATA

Installing service from a private repository server

The binaries for the installation are retrieved from a repository server. By default that server is located at https://get.aeppic.com, but can be overridden via the --server argument.

npx @aeppic/install-server --server=<REPOSITORY_SERVER_URL> [--data=<DATA_PATH>] [<SEMVER|tag>]

Note: Declaring AEPPIC_INSTALL_SERVER as environment variable also works

Install and run a private repository server

A repository server is a simple static file webserver. It uses Bearer Authentication to authenticate downloads and uploads.

npx @aeppic/install-repository-server [--data=<LOCAL_DATA_PATH>] [--port=<PORT>] [--install-location=<LOCAL_INSTALLATION_LOCATION>] [--upload-token=<UPLOAD_TOKEN_JSON_PATH>] [--download-token=<DOWNLOAD_TOKEN_JSON_PATH>]

Run via docker

Once config and data is installed and with access to the container registry it can be started via:

docker run -it --rm -p 8088:8088 --mount type=bind,source="/etc/opt/aeppic",target=/etc/opt/aeppic --mount type=bind,source="/opt/aeppic/data",target=/opt/aeppic/data --platform=linux/arm64/v8 registry.dev.curasystems.com/aeppic/aeppic-full/server:latest

To install data:

AEPPIC_DOWNLOAD_TOKEN=<TOKEN> node bin/aeppic-server.js install --data-only --data-version=latest