Nook is a lightweight, self-hosted Platform as a Service (PaaS) for deploying containerized apps. It automates the deployment, reverse proxy configuration, and SSL certificate provisioning.

Features

• Single Binary for both server and client CLI
• Automatic reverse proxy configuration with Nginx
• Automatic SSL certificate provisioning with Let's Encrypt
• Basic Lifecycle Management (start, stop, restart, delete)
• Web Dashboard for visual app management

Installation

Server

Pre-requisites

• Docker
• Nginx
• Certbot (with Nginx plugin) (python3-certbot-nginx on Debian/Ubuntu)
• A wildcard domain pointing to your server (e.g., *.yourdomain.com)

1. Download the latest release from the releases page
2. Install the binary:

   sudo mv nook /usr/local/bin/

3. Start the server:

   sudo nook server start --domain yourdomain.com

   (Note: This will secure an Nginx proxy to the API via api.yourdomain.com)

Client

1. Authenticate:

   nook login --url https://api.yourdomain.com

Usage

Web Dashboard

You can access the built-in web dashboard to manage your deployed applications visually. Once the server is started, navigate to:

https://api.yourdomain.com/dashboard

Log in using the API token generated during the nook server start command.

Deploying an App

Navigate to your app directory (must contain a Dockerfile):

Deploy the app:

nook deploy --name myapp --subdomain app --port 80

Upon successful deployment, your app will be accessible at https://app.yourdomain.com.

Managing Apps

List all deployed apps:

nook apps

Stop an app:

nook stop myapp

Refresh/Rotate API Token:

sudo nook server refresh-token

Start an app:

nook start myapp

Remove an app:

nook rm myapp

License

This project is licensed under the MIT License. See the LICENSE file for details.