Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 15 additions & 94 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,23 @@
<div id="user-content-toc">
<ul style="list-style: none;">
<summary>
<h1><samp>Nixopus</samp></h1><br>
<h6>Streamline Your Entire Server Workflow — ServerOps with No Fuss</h6>
<a href="https://nixopus.com"><img align="right" src="./assets/nixopus_logo_transparent.png" alt="Nixopus Logo" width="250" /></a>
</summary>
</ul>
<div align="center">
<img width="1800" height="520" alt="Heading(4)" src="https://github.com/user-attachments/assets/e103a9df-7abf-4f78-b75a-221331231247" />
</div>

<samp>
<table>
<tr>
<td>
<a href="https://github.com/raghavyuva/nixopus/actions/workflows/security.yml">
<img src="https://github.com/raghavyuva/nixopus/actions/workflows/security.yml/badge.svg" alt="Security Scan" />
</a>
<a href="https://github.com/raghavyuva/nixopus/actions/workflows/build_container.yml">
<img src="https://github.com/raghavyuva/nixopus/actions/workflows/build_container.yml/badge.svg" alt="Package Manager" />
</a>
<a href="https://github.com/raghavyuva/nixopus/actions/workflows/release.yml">
<img src="https://github.com/raghavyuva/nixopus/actions/workflows/release.yml/badge.svg" alt="Release" />
</a>
<br />
<a href="https://www.youtube.com/watch?v=DrDGWNq4JM4">
<img src="https://img.shields.io/youtube/views/DrDGWNq4JM4?style=social&label=View%20Demo" alt="YouTube Video Views" />
</a>
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/y/raghavyuva/nixopus">
<img src="https://madewithlove.now.sh/in?heart=true&colorA=%23ff671f&colorB=%23046a38&text=India" alt="Made with love in India" />
<br><br>
<div align="center">
<strong>
<a href="https://nixopus.com"> Website</a> |
<a href="https://docs.nixopus.com"> Documentation</a> |
<a href="https://docs.nixopus.com/blog/"> Blogs</a>
</strong>
</div>
<br>
<p align="center">
<a href="https://discord.gg/skdcq39Wpv" target="_blank">
<img src="https://user-images.githubusercontent.com/31022056/158916278-4504b838-7ecb-4ab9-a900-7dc002aade78.png" alt="Join our Discord Community" width="200" style="border-radius: 12px; box-shadow: 0px 4px 12px rgba(0,0,0,0.15);" />
</a>
</p>
</td>
</tr>
</table>
</samp>

## 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.
<p align="center">
Open Source Server management platform with Terminal integration, and Self Hosting capabilities.
</p>

<p align="center">
<a href="https://nixopus.com"><b>Website</b></a> •
<a href="https://docs.nixopus.com"><b>Documentation</b></a> •
<a href="https://docs.nixopus.com/blog/"><b>Blog</b></a> •
<a href="https://discord.gg/skdcq39Wpv"><b>Discord</b></a>
</p>

## Demo / Screenshots
<img width="1210" height="764" alt="image" src="https://github.com/user-attachments/assets/3f1dc1e0-956d-4785-8745-ed59d0390afd" />

| Self Host Stats | Team Display | File Manager |
| :-: | :-: | :-: |
| <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/28nkmy49nm7oi5tq1t8c.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/28nkmy49nm7oi5tq1t8c.webp" alt="Self Host Stats" /></a> | <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/gd5wei3oorzo6nwz96ro.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/gd5wei3oorzo6nwz96ro.webp" alt="Team Display" /></a> | <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/ikku6lr6cuqvv4ap5532.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/ikku6lr6cuqvv4ap5532.webp" alt="File Manager" /></a> |

| Self Host Logs | Dashboard Overview | Notification Preferences |
| :-: | :-: | :-: |
| <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/quinawz7qvb6b5czi7u9.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/quinawz7qvb6b5czi7u9.webp" alt="Self Host Logs" /></a> | <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/iu7s99nj347eb24b2sdz.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/iu7s99nj347eb24b2sdz.webp" alt="Dashboard Overview" /></a> | <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/jtcayilnk5oeyy3qmcrp.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/jtcayilnk5oeyy3qmcrp.webp" alt="Notification Preferences" /></a> |
> ⚠️ **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

Expand Down Expand Up @@ -90,14 +47,6 @@ curl -sSL https://install.nixopus.com | bash
curl -sSL https://install.nixopus.com | bash -s -- --skip-nixopus-install
```

### Self Host Nixopus on your VPS

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

```bash
nixopus install
```

#### Optional Parameters

You can customize your installation by providing the following optional parameters:
Expand All @@ -120,25 +69,7 @@ nixopus install \
--timeout 600
```

#### Installation with Options

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:

```bash
# Basic installation with verbose output
curl -sSL https://install.nixopus.com | bash -s -- --verbose

# Installation with custom domains
curl -sSL https://install.nixopus.com | bash -s -- --api-domain api.example.com --view-domain app.example.com

# Dry-run to see what would happen
curl -sSL https://install.nixopus.com | bash -s -- --dry-run

# Install CLI only, skip nixopus install
curl -sSL https://install.nixopus.com | bash -s -- --skip-nixopus-install
```

Run `nixopus --help` to see all available commands.
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

Expand All @@ -149,13 +80,3 @@ Nixopus is derived from the combination of "octopus" and the Linux penguin (Tux)
<a href="https://github.com/raghavyuva/nixopus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=raghavyuva/nixopus" alt="Nixopus project contributors" />
</a>

<!-- sponsors-start -->
## 🎗️ Sponsors

| Avatar | Sponsor |
| ------ | ------- |
| [![](https://avatars.githubusercontent.com/u/47430686?u=4185ecc1ab0fb92dd3f722f0d3a34ed044de0aec&v=4&s=150)](https://github.com/shravan20) | [shravan20](https://github.com/shravan20) |

❤️ Thank you for your support!
<!-- sponsors-end -->
Loading