supernets/hardfiles
supernets/hardfiles
4
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases Activity

Add Docker information to README

Browse Source
This commit is contained in:
hgw 2023-10-04 01:32:49 +00:00
parent 37ac0f9e50
commit e3e75e7b0b
Signed by: hgw
SSH Key Fingerprint: SHA256:diG7RVYHjd3aDYkZWHYcBJbImu+6zfptuUP+3k/wol4
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -17,9 +17,12 @@ HardFiles is built on the principle of flexibility. If you choose to run your ow
## Deployment Guide for HardFiles ## Deployment Guide for HardFiles
#### 1. Configuration: #### 1. Configuration:
Start by adjusting the necessary configuration variables in `main.go`. Start by adjusting the necessary configuration variables in `config.toml`.
#### 2. Build and Run
##### Bare Metal:
#### 2. Build and Run:
Execute the following commands to build and initiate HardFiles: Execute the following commands to build and initiate HardFiles:
``` ```
go build -o hardfiles main.go go build -o hardfiles main.go
@ -27,6 +30,13 @@ mkdir files
./hardfiles ./hardfiles
``` ```
##### Docker Compose:
Execute the following commands to build and initiate HardFiles in Docker:
```
docker compose up -d --build
```
#### 3. Default Port: #### 3. Default Port:
By default, HardFiles listens on port `5000`. For production environments, it's recommended to use a robust web server like Nginx or Apache to proxy traffic to this port. By default, HardFiles listens on port `5000`. For production environments, it's recommended to use a robust web server like Nginx or Apache to proxy traffic to this port.