jmorgadov/distorage

Distorage

A distributed storage system implemented in python.

Table of content

• Quick Start
  • Start a server
  • Connect a client
• Docker workflow
  • Build docker image
  • Run server
  • Run several servers at once
  • Run a temporal container

Quick start

Start a server

python main.py server [COMMAND] [ARGS]

Server commands are:

• new [PASSWORD]

  Starts a new service.

• discover [PASSWORD]

  Look for other servers in the local network.

• connect [IP_ADDR] [PASSWORD]

  Connect to a server in a specified IP address.

The [PASSWORD] argument can be omited, in that case it will be asked later in the standar input.

Conect a client

python main.py client

When entering as a client you will be asked for your name and password. If this is the first time, you can fill both fields as you want. Then you can register (or login) using that credentials.

Once inside the system you can upload and download files, deleting them from the system and see the list of files you have in the system.

Docker workflow

Build docker image

docker build --tag distorage .

⚠️ It is important to use this tag for the following to work.

Run a server

./docker_scripts/run_single_server [COMMAND] [ARGS]

Run several servers at once

./docker_scripts/run_servers [COUNT] [PASSWORD] [TERMINAL]

Where [COUNT] is the number of servers to start, [PASSWORD] the system servers pasword and [TERMINAL] the comand which opens a terminal emulator in your OS (by default it is set to alacritty)

With this option the first server will be run with the new command to start a new service and the rest will be started with the discover command.

Run a temporal container

./docker_scripts/temp_container

This is is usefull for starting clients or servers manually.