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

Change some headers

Browse Source
This commit is contained in:
hgw 2023-12-13 14:01:27 +00:00
parent e82b4661c6
commit 5a7637734a
Signed by: hgw
SSH Key Fingerprint: SHA256:diG7RVYHjd3aDYkZWHYcBJbImu+6zfptuUP+3k/wol4
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -16,7 +16,7 @@ HardFiles is built on the principle of flexibility. If you choose to run your ow
## Deployment Guide for HardFiles ## Deployment Guide for HardFiles
#### 1. Clone this repository ### 1. Clone this repository
This is necessary even when using the Docker image as the image does not contain the HardFiles frontend. This is necessary even when using the Docker image as the image does not contain the HardFiles frontend.
@ -24,12 +24,12 @@ This is necessary even when using the Docker image as the image does not contain
git clone https://git.supernets.org/supernets/hardfiles.git git clone https://git.supernets.org/supernets/hardfiles.git
``` ```
#### 2. Configuration: ### 2. Configuration:
Start by adjusting the necessary configuration variables in `config.toml`. Start by adjusting the necessary configuration variables in `config.toml`.
#### 3. Build and Run ### 3. Build and Run
##### Bare Metal: #### Bare Metal:
Execute the following commands to build and initiate HardFiles: Execute the following commands to build and initiate HardFiles:
```shell ```shell
@ -37,14 +37,14 @@ go build -o hardfiles main.go
./hardfiles ./hardfiles
``` ```
##### Docker Compose: #### Docker Compose:
Execute the following commands to build and initiate HardFiles in Docker: Execute the following commands to build and initiate HardFiles in Docker:
```shell ```shell
docker compose up -d docker compose up -d
``` ```
#### 3. Web Server Configuration: ### 3. Web Server Configuration:
By default, HardFiles listens on port `5000`. For production environments, it's recommended to use a robust web server like Nginx or Caddy 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 Caddy to proxy traffic to this port.
@ -52,7 +52,7 @@ For obtaining the Let's Encrypt certificates, you can use tools like `certbot` t
Remember, by using a reverse proxy, you can run HardFiles without needing root privileges and maintain a more secure environment. Remember, by using a reverse proxy, you can run HardFiles without needing root privileges and maintain a more secure environment.
###### Using Nginx as a Reverse Proxy: #### Using Nginx as a Reverse Proxy:
A reverse proxy takes requests from the Internet and forwards them to servers in an internal network. By doing so, it ensures that the actual application (in this case, HardFiles) doesn't need to run with root privileges or directly face the Internet, which is a security best practice. A reverse proxy takes requests from the Internet and forwards them to servers in an internal network. By doing so, it ensures that the actual application (in this case, HardFiles) doesn't need to run with root privileges or directly face the Internet, which is a security best practice.
@ -77,7 +77,7 @@ server {
Replace `your_domain.com` with your actual domain name. Save this configuration to a file, say `hardfiles.conf`, inside the `/etc/nginx/sites-available/` directory, and then create a symbolic link to `/etc/nginx/sites-enabled/`. Restart Nginx after this setup. Replace `your_domain.com` with your actual domain name. Save this configuration to a file, say `hardfiles.conf`, inside the `/etc/nginx/sites-available/` directory, and then create a symbolic link to `/etc/nginx/sites-enabled/`. Restart Nginx after this setup.
###### Using Caddy as a Reverse Proxy: #### Using Caddy as a Reverse Proxy:
Append the following to the Caddyfile, replacing your_domain.com with your chosen domain. Append the following to the Caddyfile, replacing your_domain.com with your chosen domain.