SoureCode/Deploy - Server

Roadmap

• [ ] domains property in user
• [ ] Certbot
• [ ] Roles for user
• [ ] Permission system
• [ ] Cleanup Job
  • VHost
  • Container
  • Image
  • webroot
• [ ] WebInterface
  • [ ] Login
  • [ ] Logout
  • [ ] Unregister
  • [ ] View deployments (Container list? VHost list?)
  • [ ] Admin
    • [ ] Manage user
      • [ ] Delete
      • [ ] Create
      • [ ] Set password
    • [ ] Manage VHosts
    • [ ] Manage Container

Requirements

It is designed to run on a clean server.

• Debian (tested)
• Docker
• NodeJS
• NGINX

$ sudo apt-get update
$ sudo apt-get install nginx

• build-essentials

$ sudo apt-get update
$ sudo apt-get install build-essential

Configuration

You need the following file structure:

/srv/deploy
|-- config/
|   |-- users.json # The user database
|   |-- domain.json # The domain configuration
|-- config.json # The main configuration file

config.json

This is the main configuration. It should looks like this:

{
    "secret": "yoursecret",
    "webroot": "/var/www/vhosts",
    "nginx": "/etc/nginx",
    "port": 2872,
    "users": "./config/users.json",
    "domains": "./config/domains.json",
    "register": true
}

config/users.json

Just a file storage for the user.

[]

The passwords will be hashed with argon2

Example user:

{
    "username": "admin",
    "password": "...",
    "email": "admin@sourecode.de",
    "domains": []
}

Hint: The domains property is actual not usable, but will be used to assign users only a range of domains that they can use.

config/domain.json

Used to store the usable domains.

["sourecode.de"]

Installation

Install with:

yarn global add @sourecode/deploy-server

To start the server run deploy-server in /srv/deploy.