Flare Core

Free subdomains and short URLs

Installation

Register your domain

You must have your domain to run this project.

Install Docker

1. Install Docker
2. Install Docker Compose

Clone this project

git clone https://github.com/sjy5386/flare-core

Set environment

1. Copy .env.sample.

cp .env.sample .env

2. Edit .env.

nano .env

Connect to the database

1. Copy my.cnf.sample.

cp my.cnf.sample my.cnf

2. Edit my.cnf.

nano my.cnf

MySQLdb connection options

Run

docker compose up

Deploy

sh deploy.sh

Migrate database

python manage.py migrate

Create superuser

python manage.py createsuperuser

Configure NGINX

1. Copy NGINX configuration file.

cp ./docker/nginx/sites-enabled/flare.conf <your-nginx-sites-enabled-directory>

2. Edit your NGINX configuration file.

nano <your-nginx-sites-enabled-directory>/flare.conf

• You can get static files from ./out/static.

3. Reload NGINX.

nginx -s reload

Usage

Subdomains

1. You must have at least one contact created.
2. Search for available subdomain names.
3. Create a available subdomain.
4. Add dns records.