Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drylikov/jaydon
Nginx control panel.
https://github.com/drylikov/jaydon
Last synced: 8 days ago
JSON representation
Nginx control panel.
- Host: GitHub
- URL: https://github.com/drylikov/jaydon
- Owner: drylikov
- License: mit
- Created: 2024-08-14T06:22:18.000Z (3 months ago)
- Default Branch: drylikov
- Last Pushed: 2024-08-14T06:27:12.000Z (3 months ago)
- Last Synced: 2024-08-14T07:41:24.761Z (3 months ago)
- Language: JavaScript
- Size: 272 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Jaydon
Nginx Control Panel
> This is an experimental control panel written for a niche reason. Use at your own risk.
## Quick Installation
Ubuntu v22
```
curl -L https://raw.githubusercontent.com/drylikov/jaydon/master/install22.sh | bash
```
Ubuntu v18
```
curl -L https://raw.githubusercontent.com/drylikov/jaydon/master/install18.sh | bash
```
## Before Installation
> Unlike other control panels with Jaydon you control the versions of your softwares such as Nginx, Node.js etc.
Before you install Jaydon you need:
- [MongoDB](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/)
- [Certbot](https://certbot.eff.org/lets-encrypt/ubuntubionic-nginx)
- [Nginx](https://www.nginx.com/resources/wiki/start/topics/tutorials/install/)
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [Node.js](https://nodejs.org/en/download/package-manager/) & [NPM](https://www.npmjs.com/get-npm)
- [Yarn](https://www.npmjs.com/package/yarn)
- [PM2](https://www.npmjs.com/package/pm2)
Ubuntu v22
```
# Install essential tools
sudo apt-get update
sudo apt-get install build-essential -y
# Install MongoDB
curl -fsSL https://www.mongodb.org/static/pgp/server-6.0.asc | sudo gpg --dearmor -o /usr/share/keyrings/mongodb-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/mongodb-archive-keyring.gpg arch=amd64,arm64] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/6.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list
sudo apt update
sudo apt install mongodb-org -y
sudo systemctl start mongod
sudo systemctl enable mongod
# Install Certbot
sudo snap install core
sudo snap refresh core
sudo snap install --classic certbot -y
sudo ln -s /snap/bin/certbot /usr/bin/certbot
# Install Nginx
sudo apt install nginx -y
# Install Git
sudo apt install git -y
# Install Node.js
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt install nodejs -y
# Install Yarn
sudo npm i -g yarn
# Install PM2
sudo npm i -g pm2
```
Ubuntu v18
```
# Install MongoDB
sudo apt install gnupg -y
wget -qO - https://www.mongodb.org/static/pgp/server-4.2.asc | sudo apt-key add -
echo "deb [ arch=amd64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/4.2 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.2.list
sudo apt update -y
sudo apt install mongodb-org -y
sudo service mongod start
systemctl enable mongod.service
# Install Certbot
sudo apt install software-properties-common -y
sudo add-apt-repository universe -y
sudo add-apt-repository ppa:certbot/certbot -y
sudo apt update -y
sudo apt install certbot python-certbot-nginx -y
# Install Nginx
sudo apt install nginx -y
# Install Git
sudo apt install git -y
# Install Node.js
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt install nodejs -y
# Install Yarn
sudo npm i -g yarn
# Install PM2
sudo npm i -g pm2
```
## Installation
If you have all the dependencies above now you can install Jaydon.
```
# Clone Git repository
git clone https://github.com/drylikov/jaydon.git && cd jaydon
# Install dependencies
yarn install
# Build React app
yarn build
# Create necessary database tables
yarn run firstRun
# Start server with PM2
pm2 start ./src/backend/server.js --name jaydon -i max
pm2 startup
pm2 save
# Open your browser and go to
http://your-ip:1148
```
## Update
Make sure update.sh is executable.
```
chmod +x update.sh
```
And just run it.
```
./update.sh
```
## API
Jaydon API built on [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). It accepts requests as JSON and returns responses as JSON too.
Base URL.
```
http://your-ip:1148/api/v1
```
Example POST request.
```json
{
"meta": {
"apiKey": "YOUR_API_KEY",
"category": "domain|cronJob",
"event": "create|read|update|delete"
},
"data": {
}
}
```
"data" object.
```json
// create domain
"data": {
"domain": "example.com",
"gitSupport": true,
"sslSupport": true,
"nginxConf": "configuration"
}
// read a domain
"data": {
"id": "domain id"
}
// read domains
"data": {
}
// update domain
"data": {
"id": "domain id",
"domain": "example.com",
"gitSupport": false,
"sslSupport": false,
"nginxConf": "configuration"
}
// delete domain
"data": {
"id": "domain id"
}
---
// create cron job
"data": {
"command": "node script.js",
"schedule": "* * * * *"
}
// read a cron job
"data": {
"id": "cron job id"
}
// read cron jobs
"data": {
}
// update cron job
"data": {
"id": "cron job id",
"command": "node script.js",
"schedule": "* * * * *"
}
// delete cron job
"data": {
"id": "cron job id"
}
```
Example 1: Create a domain with cURL.
```bash
curl http://your-ip:1148/api/v1 \
-X POST \
-H "Content-Type: application/json" \
--data-binary @- << EOF
{
"meta": { "apiKey": "YOUR_API_KEY", "category": "domain", "event": "create" },
"data": { "domain": "test.com", "gitSupport": false }
}
EOF
# {"success":true}
# {"success":false,"error":"error"}
```
Example 2: Update a cron job with Axios.
```js
const axios = require('axios')
const postUrl = 'http://your-ip:1148/api/v1'
const postData = {
meta: { apiKey: 'YOUR_API_KEY', category: 'cronJob', event: 'update' },
data: { id: 'CRON_JOB_ID', command: '/usr/bin/node ~/script.js', schedule: '0 * * * *' }
}
axios
.post(postUrl, postData)
.then(res => {
console.log(res.data)
// {"success":true}
// {"success":false,"error":"error"}
})
.catch(err => {
console.log(err)
})
```
## Preview
## Todo
- [ ] Domains
- [ ] Git
- [ ] SSL
- [ ] Cron Jobs
- [ ] DNS
- [ ] Logs
- [ ] Monitor
- [ ] API