Introduction#
Smilin' File Hosting is a Zero Knowledge file hosting service written in Python. I wrote this as a hobby project for my cousins, and it's turned into something a lot more cool.
Installation#
This program has two parts, the Server (main API) and the Client.
Server#
To run the server, install Docker (specifically, docker-compose).
You have to install Docker Desktop
First, install Docker and then run this;
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
Install homebrew, if it's not installed and then run this;
brew install docker-compose
Afterwards, open up a Terminal and cd to the 'server/' directory and run
docker-compose up -d
This creates two containers;
- A Python Container (The Main API)
- A MariaDB Container (The Main Database)
The Python Container contains the main server, which exposes Port 2356, and the MariaDB Container contains a MariaDB Database with the user and password specified in the docker-compose file.
Client#
To run the client, you'll need a python interpreter. The program was written using Python 3.10, so install either 3.10 or any version above 3.10. You may download it from here.
Afterwards, cd to the 'client/', create a virtual environment1 and install the requirements.
python -m venv ./venv/
./venv/Scripts/activate
python -m pip install -r requirements.txt
python3 -m venv ./venv/
source ./venv/bin/activate
python3 -m pip install -r requirements.txt
Or, if you want to use Anaconda / Miniconda;
conda env create -f environment.yml
conda activate smilin_file_client
This installs all the packages required by the Client to the virtual environment.
You may finally run the program by typing;
python main.py
python3 main.py
-
Instead of using the system-wide or local interpreter, it's safer and more efficient to use a virtual environment.
Note that you don't have to use python's "venv", you can even use an Anaconda Environment, as specified right under. ↩