Skip to content

leil-io/saunafs-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SaunaFS REST API

About

This repository provides a REST API and a python library to interact with a SaunaFS cluster. Currently it provides most of the monitoring and features from the CGI.

Setup

It is recommended to use Docker for running this. For instructions on how to install docker, see here.

After installing docker, you should be able to just do:

docker buildx build . -t saunafs-api:latest

Then copy the .env.example to .env and change the settings as you please.

cp .env.example .env

Finally, you can run docker-compose up.

You can access the docs at:

`http://:/docs

Documentation

An incomplete documentation is provided directly on http://<saunafs-api-host>:<port>/docs, however if you have questions regarding the API, please create an issue

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.

About

A REST API for interacting with SaunaFS

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published