Skip to content

raghavyuva/nixopus

Repository files navigation

    Nixopus


    Streamline Your Entire Server Workflow — ServerOps with No Fuss
    Nixopus Logo
Security Scan Package Manager Release
YouTube Video Views GitHub commit activity Made with love in India


Join our Discord Community

Project Overview

Nixopus streamlines your workflow with comprehensive tools for deployment, monitoring, and maintenance.

⚠️ Important Note: Nixopus is currently in alpha/pre-release stage and is not yet ready for production use. While you're welcome to try it out, we recommend waiting for the beta or stable release before using it in production environments. The platform is still undergoing testing and development.

Demo / Screenshots

Self Host Stats Team Display File Manager
Self Host Stats Team Display File Manager
Self Host Logs Dashboard Overview Notification Preferences
Self Host Logs Dashboard Overview Notification Preferences

Features

  • Deploy apps with one click. No config files, no SSH commands.
  • Manage files in your browser. Drag, drop, edit. Like any file manager.
  • Built-in terminal. Access your server without leaving the page.
  • Real-time monitoring. See CPU, RAM, disk usage at a glance.
  • Auto SSL certificates. Your domains get HTTPS automatically.
  • GitHub integration. Push code → auto deploy.
  • Proxy management. Route traffic with Caddy reverse proxy.
  • Smart alerts. Get notified via Slack, Discord, or email when something's wrong.

Installation & Quick Start

This section will help you set up Nixopus on your VPS quickly.

Install the Nixopus CLI

First, install the Nixopus CLI tool:

curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install-cli.sh | sudo bash

Self Host Nixopus on your VPS

Once the CLI is installed, you can self host Nixopus on your VPS:

nixopus install

Optional Parameters

You can customize your installation by providing the following optional parameters:

  • --api-domain or -ad: Specify the domain where the Nixopus API will be accessible (e.g., nixopusapi.example.tld)
  • --view-domain or -vd: Specify the domain where the Nixopus app will be accessible (e.g., nixopus.example.tld)
  • --verbose or -v: Show more details while installing
  • --timeout or -t: Set timeout for each step (default: 300 seconds)
  • --force or -f: Replace files if they already exist
  • --dry-run or -d: See what would happen without making changes
  • --config-file or -c: Path to custom config file (defaults to built-in config.prod.yaml)

Example with optional parameters:

nixopus install \
  --api-domain nixopusapi.example.tld \
  --view-domain nixopus.example.tld \
  --verbose \
  --timeout 600

Additional CLI Commands

The Nixopus CLI provides several other useful commands:

  • nixopus preflight - Check system requirements before installation
  • nixopus install deps - Install only dependencies
  • nixopus install ssh - Generate SSH keys for deployment
  • nixopus service - Manage Nixopus services
  • nixopus uninstall - Remove Nixopus from your system

Run nixopus --help to see all available commands.

About the Name

Nixopus is derived from the combination of "octopus" and the Linux penguin (Tux). While the name might suggest a connection to NixOS, Nixopus is an independent project with no direct relation to NixOS or its ecosystem.

Contributors

Nixopus project contributors

🎗️ Sponsors

Avatar Sponsor
shravan20

❤️ Thank you for your support!