Nua

Warning This code is still evolving quickly, and not meant for production yet.

What is Nua?

Vision

Nua is an open source, self-hosted cloud platform project (a PaaS - platform as a service).

Nua streamlines the development, selection, installation and resilient operation of web applications in a self-hosted cloud environment.

It is primarily aimed at users (SMEs, associations, public services, etc.) who wish to benefit from the simplicity of the cloud at the lowest cost without compromising the principles of digital sovereignty.

Its watchwords are: simplicity, resilience and equity.

Concept Map

Use cases

Presentation

See: https://speakerdeck.com/sfermigier/nua-a-self-hosted-resilient-paas

---

Hacking on Nua

Technical Architecture

Subpackages

The Nua project is a monorepo, split into several subpackages:

• nua-lib: common code for all Nua packages (details).
• nua-cli: command-line interface for Nua (details).
• nua-agent: agent for Nua apps (details).
• nua-build: build system for Nua packages (details).
• nua-orchestrator: orchestrator for Nua applications (details).
• nua-server: web UI for a Nua iserver (details). Not ready yet.

It also comprises several example applications, as well as a few real-world applications: apps.

To install a development environment, you will need Poetry, and to run:

poetry install

You also need a Docker server.

Roadmap and current status

The roadmap for the projet is kept up to date on this kanban board.

See also: TODO.md and HISTORY.md.

We currently provide the following components:

• The "builder" CLI that can build container images from high level specifications (nua-config.tom files).
• The "orchestrator" CLI that can deploy and manage container images.
• The nua CLI that provides a unified interface to the builder and orchestrator.
• Some initial applications (HedgeDoc, Dolibarr, Galene, Dolibarr, Etherpad-lite).

Repo activity

Nua CLI

$ nua
nua (0.5.17)

Usage:
  nua <command> [options] [arguments]

Options:
  -V  Show version and exit
  -d  Enable debug mode
  -v  Increase verbosity

Available commands:
  apps     List applications.
  backup   Backup a deployed application.
  build    Build app but don't deploy it.
  deploy   Deploy app.
  destroy  Destroy an application.
  help     Show help.
  logs     Show application logs.
  restart  Restart an application.
  restore  Restore backup data of a deployed application.
  start    Start an application.
  stop     Stop an application.
  update   Update an application.

 config
  config show      Show application config.

 env
  env set          Show application env variables.
  env show         Show application env variables.

 server
  server cleanup   Cleanup server (remove inactive docker images and containers).
  server logs      Show server logs.
  server ps        List all server processes.
  server settings  Show server settings.
  server status    Show Nua status.
  server uptime    Show server uptime.

REUSE (licensing compliance)

Result of the reuse lint command invocation:

$ reuse lint
> * Bad licenses:
> * Deprecated licenses:
> * Licenses without file extension:
> * Missing licenses:
> * Unused licenses:
> * Used licenses: AGPL-3.0-only, CC-BY-4.0, MIT
> * Read errors: 0
> * Files with copyright information: 284 / 284
> * Files with license information: 284 / 284

> Congratulations! Your project is compliant with version 3.0 of the REUSE Specification :-)