Skip to content

Creating an API Checkpoint

Jump to bottom
tago edited this page May 9, 2024 · 13 revisions

How to Setup the Flare Flask API

Flare and AKoD now use an API instead of pip package for security, and flexibility. Flask API is a type of web API and is designed to make it easy and quick to start building web applications. This API will be used to send a check requests to your auth servers, which should be local, and then return a valid or invalid text.

Setting up a virtual environment

  1. In the Flare directory, cd into the 'api' folder 
    cd ./api
  2. Activate the environment 
    source env/bin/activate
  3. Install the necessary modules if they aren't already included 
    sudo pip3 install -r requirements.txt
  4. Leave the API virtual environment 
    deactivate

Tunnel API through Cloudflare

  1. Head back to Cloudflare Zero Trust dashboard
  2. Select "Networks" then "Tunnels"
  3. Click on the menu for the tunnel you have active (assuming your running the API on the same server)
  4. Configure, then select the "Public Hostname" tab
  5. Add a public host name
  6. Choose a name for the subdomain and select your domain
  7. Select HTTP type and the internal server IP for your Linux server, along with the port 5000 (it should look like HTTP://10.11.32.121:5000)
  8. Save the hostname

If you've been following step-by-step

Flare is ready 🔥

Your server must be running ALL services in order to work properly

Learn how to run all 5 Flare services


Once your services are online, you can finally implement your license checking in your code!

You have actually completely setup Flare! I think... unless you didnt ant your just on this wiki page and reading this... I don't know who is doing this or who ever would I'm just kinda creating and fixing and writing. The more I think about it, I'm just one of those weirdos who's obsessed with art and posts it all over my page but luckily I don't make it my entire personality, and I barely post about it because no one I know (less than 5 people) likes to or is even slightly into coding. I've been very dedicated to this project and I even got a raspberry pi 5 to use with! hopefully soon I make a video with it to try and get Flare out there more. Who are you writing this to? Why are you still typing? Are you talking to yourself right now...?
~ tago

Clone this wiki locally