Skip to content

Commit

Permalink
Add Docker information to README
Browse files Browse the repository at this point in the history
  • Loading branch information
hgw8 committed Oct 4, 2023
1 parent 37ac0f9 commit e3e75e7
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,26 @@ 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
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.

Expand Down

0 comments on commit e3e75e7

Please sign in to comment.