x64mayhem/skydaddy repository overview

⁠SkyDaddy⁠ - Minimal, Scalable File Sharing Server

You can deploy this application without scaling using gunicorn on your local machine/server, or you can utilise docker to scale the application. If you intend to use this with more than 3-4 users, it is recommended that you scale it up.

⁠Local Hosting

To deploy this on your local machine, you will need to install python3. It is suggested that you use a virtual environment to set up the dependencies.

⁠Python Setup

⁠Ubuntu

sudo apt-get install python3 python3-pip virtualenv

⁠MacOS

brew install [email protected] virtualenv

⁠Create a virtual env.

virtualenv -p $(which python3) ~/SkyDaddyEnv

⁠Install required python packages

source ~/SkyDaddyEnv/bin/activate
pip install -r requirements.txt
deactivate

⁠Hosting

source ~/SkyDaddyEnv/bin/activate
./serve_local.sh

⁠Docker deployment & Scaling

⁠Scaling factor

You can change the number of instances you want to run by changing the replicas: 3 under deploy: in skydaddy service in docker-compose.yml or you can pass the --scale skydaddy=x (where x is the number of instances you want to run) to ./serve_docker script. The later will override the parameters of the compose configuration.

version: "3.9"

services:
  skydaddy:
    build:
      context: app
#  <...>
    deploy:
      replicas: 3
#  <...>

⁠Composing

You can compose the containers using ./serve_docker.sh by -

./serve_docker.sh

or

You can manually do it by -

docker compose up -d --build --scale skydaddy=3 nginx=1

You can also pass parameters for docker compose⁠ by appending them to the script call:

./serve_docker.sh --build

⁠TODO

• Add linter workflow (Code:Readability)
• Add function tests (Code:Correctness)
• Improve UI (Design:UI/UX)
• Add password lock on commands. (Security:Authentication)
• Implement public key encryption while storing files. (Security:Privacy, Security:Confidentiality)

⁠License

MIT | Copyright (c) 2023 Saket Upadhyay⁠