Add Docker information to README
This commit is contained in:
parent
37ac0f9e50
commit
e3e75e7b0b
14
README.md
14
README.md
@ -17,9 +17,12 @@ HardFiles is built on the principle of flexibility. If you choose to run your ow
|
||||
## Deployment Guide for HardFiles
|
||||
|
||||
#### 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:
|
||||
```
|
||||
go build -o hardfiles main.go
|
||||
@ -27,6 +30,13 @@ mkdir files
|
||||
./hardfiles
|
||||
```
|
||||
|
||||
##### Docker Compose:
|
||||
|
||||
Execute the following commands to build and initiate HardFiles in Docker:
|
||||
```
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
#### 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.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user