Ordinary Server

Server daemon for Ordinary.

Installation

Prebuilt releases are provided here.

Note: When building from source, esbuild will need to be installed because it is used to bundle the built-in TypeScript/JavaScript files.

git

## clone
git clone https://codeberg.org/ordinarylabs/Ordinary.git

## install (will take awhile)
cargo install --path Ordinary/core/apps/daemon/

crates.io

cargo install ordinaryd@0.6.0

## OR if your platform has prebuilt binaries in <https://codeberg.org/ordinarylabs/Ordinary/releases>
cargo binstall ordinaryd@0.6.0

Homebrew

## add the Ordinary Labs tap
brew tap ordinarylabs/tap --custom-remote https://codeberg.org/ordinarylabs/homebrew-tap

## supported for `aarch64-apple-darwin`, `aarch64-unknown-linux-gnu`, `x86_64-unknown-linux-gnu`
brew install ordinaryd

Quick Start

Initialize a new instance.

ordinaryd init \
    --password '******' \
    --environment development \
    --api-domain ordinaryd.local \
    --storage-size 10000000

Start initialized instance.

ordinaryd api \
    --environment development \
    --provision localhost \
    --insecure \
    --port 4433 \
    --redirect-port 8080 \
    --storage-size 10000000 \
    --stdio-logs \
    --swagger

CLI Documentation

ordinaryd --help

See: docs/cli-reference.md.

On Shutdown (terminate/ctrl-c)

When shutdown, the daemon will "gracefully" shut down all open http1/http2 connections via hyper's graceful_shutdown method; this should allow for all connection dependent tasks to resolve prior to termination.

Non-connection based background tasks (cache and log syncing) still need to be set up to run a final time prior to termination and after all connections have been closed.

License

Licensed under the GNU AGPLv3: https://www.gnu.org/licenses/agpl-3.0.html

Security

THIS CODE HAS NOT BEEN AUDITED OR REVIEWED. USE AT YOUR OWN RISK.

Refer to the Security Policy.

ordinaryd 0.6.0