crony/UpFast
1
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 4 Activity

Merge pull request 'readme' (#1) from TlasT/UpFast:readme into main

Browse Source 
Reviewed-on: #1
Changes are all good don't worry. Nothing really ambitious there.
This commit is contained in:
CronyAkatsuki 2023-03-26 15:17:21 +00:00
commit 9abd361c7f
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,6 +1,6 @@
# UpFast # UpFast
simple tool for uploading and sharing files that is selfhostable. Simple tool for uploading and sharing files that you can self-host.
## How to host ## How to host
@ -15,28 +15,27 @@ We will also be setting up an specific user to run the app as safe as possible w
sudo useradd --shell /bin/bash --system \ sudo useradd --shell /bin/bash --system \
--home-dir "/usr/local/upfast" -m upfast --home-dir "/usr/local/upfast" -m upfast
# Change to upfast user and cd /usr/local/upfast # Change to upfast user and go to upfast dir
su upfast su upfast
cd /usr/local/upfast cd
# Clone the project directly into upfast-src directory # Clone the project directly into upfast-src directory
git clone https://code.cronyakatsuki.xyz/crony/upfast upfast-src git clone https://code.cronyakatsuki.xyz/crony/upfast .
# Create the virtual environment and load it for user on default # Create the virtual environment and load it for user on default
python3 -m venv venv python3 -m venv venv
echo "source /usr/local/upfast/venv/bin/activate" > "/usr/local/upfast/.profile"
# Activate the virtual environment # Activate the virtual environment
source venv/bin/activate source venv/bin/activate
# Install all the requirements # Install all the requirements
cd upfast-src/
pip install -r requirements.txt pip install -r requirements.txt
# Load environment by default
echo "source /usr/local/upfast/venv/bin/activate" > "/usr/local/upfast/.profile"
# create the upload directory # create the upload directory
mkdir upload mkdir upload
# Run the project # UpFast go brrr
uvicorn main:app --host 127.0.0.1 --port 8000 --proxy-headers --forwarded-allow-ips='*' uvicorn main:app --host 127.0.0.1 --port 8000 --proxy-headers --forwarded-allow-ips='*'
``` ```
@ -52,12 +51,18 @@ Documentation=https://code.cronyakatsuki.xyz/crony/upfast
[Service] [Service]
User=upfast User=upfast
Group=upfast Group=upfast
WorkingDirectory=/usr/local/upfast/upfast-src WorkingDirectory=/usr/local/upfast/
ExecStart=/usr/local/upfast/venv/bin/uvicorn main:app --host 127.0.0.1 --port 8000 --proxy-headers --forwarded-allow-ips='*' ExecStart=/usr/local/upfast/venv/bin/uvicorn main:app --host 127.0.0.1 --port 8000 --proxy-headers --forwarded-allow-ips='*'
Restart=on-failure Restart=on-failure
``` ```
Finally run following commmands.
Then just run `sudo systemctl daemon-reload` and enable the service with `sudo systemctl enable upfast.service` ```
# refresh services
`sudo systemctl daemon-reload`
# enable the service
`sudo systemctl enable upfast.service`
```
### Docker ### Docker