An open API service indexing awesome lists of open source software.

https://github.com/raghavyuva/nixopus

Open Source Alternative to vercel, heroku, netlify with simplified workflows
https://github.com/raghavyuva/nixopus

ci-cd coolify deployment file-manager golang heroku homelab netlify nextjs self-hosted terminal typescript vercel vps vps-server

Last synced: 8 days ago
JSON representation

Open Source Alternative to vercel, heroku, netlify with simplified workflows

Awesome Lists containing this project

README

          


Heading(4)


Open Source alternative to vercel, heroku, netlify with Terminal integration, and Self Hosting capabilities.


Website
Documentation
Blog
Discord
Roadmap




raghavyuva/nixopus | Trendshift



image

> ⚠️ **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.

# 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.

> 💡 **Quick Tip**: Use our [**Install Command Generator**](https://docs.nixopus.com/install/#generate-your-installation-command) to customize your installation command with a visual interface!

### Install Nixopus

**To get started without domain names, and to try out over ip:port deployment:**

```bash
sudo curl -sSL https://install.nixopus.com | bash
```

**For custom ip setups:**

```bash
sudo curl -sSL https://install.nixopus.com | bash -s -- --host-ip 10.0.0.154
```

**To install only the CLI tool without running `nixopus install`:**

```bash
sudo curl -sSL https://install.nixopus.com | bash -s -- --skip-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`)
- `--host-ip` or `-ip`: Specify the IP address of the server to use when no domains are provided (e.g., `10.0.0.154` or `192.168.1.100`). If not provided, the public IP will be automatically detected.
- `--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`](https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/helpers/config.prod.yaml))

Example with optional parameters:

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

Example for custom ip setup:

```bash
sudo nixopus install \
--host-ip 10.0.0.154 \
--verbose
```

> [!NOTE]
> Running `nixopus install` requires root privileges (sudo) to install system dependencies like Docker. If you encounter permission errors, make sure to run the command with `sudo`.

You can also install the CLI and run `nixopus install` with options in a single command, refer [installation documentation](https://docs.nixopus.com/install/#installation-options) for more details on options

## 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](https://nixos.org/), Nixopus is an independent project with no direct relation to NixOS or its ecosystem.

## Contributors


Nixopus project contributors