Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.92 KB

README.md

File metadata and controls

49 lines (32 loc) · 1.92 KB
Raw

pfs

📂 Server for pasting, uploading, and downloading files. Built on an API that serves data to the frontend, allowing both developers and casual i-net users to browse file contents.

To start using pfs

pfs uses Docker to create and manage the programs used to make pfs work.

git clone https://github.com/insyri/pfs
cd pfs
# Create and populate ./pfs.toml, or use the example: ./pfs.example.toml
chmod +x ./start-pfs.sh
./start-pfs.sh --config ./pfs.example.toml

Development

pfs has a contributing guide, it contains contributing guidelines and more in-depth development setup specifications.

On *nix1 systems, users can run this one liner in the project directory:

./start-pfs.sh --env dev --config ./pfs.example.toml

For Windows systems, users will have to use WSL and open the project inside the Linux file system.

Footnotes

  1. Unix, unix-like, and unix based. E.g.: MacOS, Linux, and Windows Subsystem for Linux. ↩