Netflux ESIR - Backend

This repository contains the backend of the Netflux ESIR project used to store metadata and videos representations in DB.

Install

Requirements

• git
• Go
• An AWS S3 bucket
• A PostgreSQL database

Run from source

Build the server

git clone https://https://github.com/NetfluxESIR/backend.git
cd backend
make build

Run the server

Don't forget to set "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY" environment variables to access to your S3 bucket.

Start the Netflux API server.

Usage:
  netflux serve [flags]

Flags:
  -a, --admin-account string    Admin account. (default "admin")
  -P, --admin-password string   Admin password. (default "admin")
  -d, --dsn string              Data source name. (default "netflux:netflux@postgres:5432/netflux?sslmode=disable")
  -h, --help                    help for serve
  -H, --host string             Host to listen on. (default "localhost")
  -l, --loglevel string         Log level. (default "info")
  -p, --port int                Port to listen on. (default 8080)
  -b, --s3-bucket string        S3 bucket name.
  -r, --s3-region string        S3 region.

Run with Docker

Requirements

• Docker
• Docker Compose (optional)

You still have to set "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY" environment variables to access to your S3 bucket.

You can find a docker image of the backend here.

docker run -p 8080:8080 ghcr.io/netfluxesir/backend:latest serve --s3-bucket <your-bucket-name> --s3-region <your-bucket-region>

Note: you can also use the docker-compose.yml file to run the backend and the database locally.

API Documentation

You can find the API documentation here.