tarolas

README

tarolas

Lightweight file storage service written in Go.

Installation

Download and unpack sources from release you need and build tarolas binary.

For Linux:

./build.sh

Fow Windows:

build.cmd

Running

Tarolas server requires single configuration file given in command line:

tarolas --config my_tarolas_config.json 

Configuration options are described in details in Configuration section.

The simplest configuration file may look like the following (on Windows):

{
  "serverPort": 15000,
  "rootDirectory": "C:\\Temp\\tarolas"
} 

or like this (on Linux):

{
  "serverPort": 15000,
  "rootDirectory": "/home/john/tarolas"
}

You can find prepared configuration file in config directory in project source.

After starting tarolas server you will see the following messages in console (on Windows):

tarolas v0.0.1
  >>    server port : 15000
  >> root directory : C:\Temp\tarolas 

or (on Linux):

tarolas v0.0.1
  >>    server port : 15000
  >> root directory : /home/john/tarolas

The tarolas file server is ready to serve your files!

Configuration

• port number the sever will be listening on
• root directory for storing files
• public key for JWT token verification

Functionality

Directories

• list directory tree,
• list directory content,
• create directory,
• delete directory,
• move directory,
• copy directory.

Files

• create file,
• append file,
• delete file,
• move file,
• copy file,
• share file,
• read file.

Security

Directories and files may be accessed without any restrictions. Usually this is not a good idea. That's why any operation may be restricted only to user who has required rights granted.

License

MIT