Kopoze

DevOps toolikts made with go.

Note: The project is still in active development so there will be a lot of bug. And all step here was only tested on Ubuntu 20.04.

Requirements

• PostresSQL
• Nginx or Apache2
• Mkcert

Install

For local use

For local use, this cli is to simplify subdomain-port mapping with https of your local project.

Get the app

To get this app, go to the release page and choose the version according to your architecture.

Next, move it inside your /usr/local/bin/ folder.

cd /Download/
wget -c https://github.com/kopoze/kpz/releases/download/{tag}/{filename}
mv ./kpz /urs/local/bin/

Or you can clone this repo and manually compile this project on your computer.

git clone https://github.com/kopoze/kpz
cd kpz
go get -d -v ./...
make

You will find the .deb inside the build folder.

You then can install you .deb with:

sudo dpkg -i kpz-*.deb

Init configuration

To set up default config, run the following command first:

sudo kpz configure

Configuration file can be found under /etc/kopoze/kopoze.toml. You can modify it depends on your local configuration.

Generate certificate for local https

Generate certificate for a wildcard subdomain.

mkcert *.project.mg

The domain value need to match the value you set inside your config file under kopoze.domain.

To install and configure Mkcert, you can read more here.

Configure nginx

Now create subdomain configuration under /etc/nginx/sites-availble/sub.project.mg with the following value.

server {
    server_name *.project.mg;

    location / {
    proxy_pass http://localhost:8080;
    proxy_pass_header Set-Cookie;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Forwarded-Host $host;
    proxy_set_header Cookie $http_cookie;

    proxy_cookie_path / /;
    client_max_body_size 5m;
    }


    listen 443 ssl; # managed by Certbot
    ssl_certificate /etc/letsencrypt/live/_wildcard.project.mg/_wildcard.project.mg.pem; # managed by Certbot
    ssl_certificate_key /etc/letsencrypt/live/_wildcard.project.mg/_wildcard.project.mg-key.pem; # managed by Certbot
    include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot

}
server {
    if ($host = *.project.mg) {
        return 301 https://$host$request_uri;
    } # managed by Certbot

    server_name *.project.mg;
    listen 80;
    return 404; # managed by Certbot
}

Don't forget to change the value of ssl_certificate and ssl_certificate_key with the path of the generated certificate with mkcert earlier.

Note that the port used inside your config is the port that will be used when starting our script with kpz serve.

At the end, validate your configuration with sudo nginx -t and if everything is ok, restart your nginx server with sudo systemctl restart nginx.

Configure Apache2

If you prefere using apache, here is a configuration you can use:

<VirtualHost *:443>
    ServerName project.mg
    ServerAlias *.project.mg

    SSLEngine on
    ProxyPreserveHost On
    SSLCertificateFile /etc/letsencrypt/live/_wildcard.project.mg/_wildcard.project.mg.pem
    SSLCertificateKeyFile /etc/letsencrypt/live/_wildcard.project.mg/_wildcard.project.mg-key.pem

    ProxyPass / http://localhost:8080/
    ProxyPassReverse / http://localhost:8080/
</VirtualHost>

Don't forget to enable these following module:

sudo a2enmod proxy
sudo a2enmod proxy_http
sudo a2enmod ssl

Enable your config with:

sudo a2ensite project.mg.conf

And finally, restart your apache2 with:

sudo service apache2 restart

PostgreSQL configuration

To configure your database, edit the config file inside /etc/kopoze/kopoze.toml and put your custom value. Default value for database configuration is:

[database]
engine = 'postgresql'
host = 'localhost'
password = 'root'
port = '5432'
user = 'root'
name = 'kopoze'

Run the program

Now you can run the cli with

sudo kpz serve

Note that in local mode, to update existing hosts, you must run this app in sudo mode.

Add your app

You can use the existing API under http://locahost:8080/cli/apps/ or add directly your entry inside PostresSQL.

Here is the JSON format to create app:

POST http://localhost:8080/cli/apps/
Content-Type: application/json

{
    "name": "App1",
    "subdomain": "app1",
    "port": 9000
}

Thanks to txeh, you can manually add subdomains with:

sudo kpz subdomain add [sub1] [sub2] [sub3]

And remove them whith:

sudo kpz subdomain remove [sub1] [sub2] [sub3]

Limitation

For know, accessing Django admin with this tool need specific configuration on Django side because sessionId cookies is not set. Still can't figure out the way out.

Author

© Kopoze 2023