Skip to content

Commit ea89b8a

Browse files
committed
update readme
1 parent 9d0b880 commit ea89b8a

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

readme.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,18 @@ You can see the Structure below:
9595
To run all that, you must install docker along with docker compose. Then get the compose file you want:
9696

9797
```bash
98+
99+
# http version
98100
wget https://raw.githubusercontent.com/Dpbm/qserver/refs/heads/main/compose.yml
101+
# https version
102+
wget https://raw.githubusercontent.com/Dpbm/qserver/refs/heads/main/compose-https.yml
99103

100104
# or
101105

106+
# http version
102107
wget https://raw.githubusercontent.com/Dpbm/qserver/refs/heads/main/ghcr-prod-compose.yml
108+
# https version
109+
wget https://raw.githubusercontent.com/Dpbm/qserver/refs/heads/main/ghcr-prod-compose-https.yml
103110
```
104111

105112
Then, you must set some env variables to configure the services access:
@@ -111,17 +118,13 @@ export DB_ROOT_USER="root username"
111118
export DB_ROOT_PASSWORD="root db user password"
112119
export RABBITMQ_USER="rabbitmq username"
113120
export RABBITMQ_PASSWORD="rabbitmq password"
114-
```
115-
116-
Also, if you want to add https, you need to setup the `DOMAIN` variable:
117-
118-
```bash
119-
export DOMAIN="your domain"
121+
export DOMAIN="your domain" # it can be arbitrary if not using HTTPS or running in local environments
120122
```
121123

122124
`Note: Remember to not use hard set env variables in production. Use your cloud provider secure alternative`
123125

124-
It's not mandatory, but we recommend you doing that. In case you're going to setup HTTPS, there's a script to setup your certs using `certbot`. Doing that is, sometimes, very trick, so I'm letting here the setup I did in my environment, but remember to check [let's encrypt documentation](https://letsencrypt.org/docs/) and [certbot's](https://certbot.eff.org/) as well.
126+
127+
Using HTTPS is not mandatory, but we recommend you doing that. In case you're going to setup HTTPS, there's a script to setup your certs using `certbot`. Doing that is, sometimes, very trick, so I'm letting here the setup I did in my environment, but remember to check [let's encrypt documentation](https://letsencrypt.org/docs/) and [certbot's](https://certbot.eff.org/) as well.
125128

126129
In my case, I bought a real domain that can be reach outside on the internet and them used certbot to generate the certificates.
127130

@@ -257,6 +260,8 @@ chmod +x test.sh
257260
./test.sh
258261
```
259262

263+
You can also change it to run the http version, just update the `dev-compose.yml` file.
264+
260265
### GRPC server as DEV
261266

262267
First of all, install the go dependencies:

0 commit comments

Comments
 (0)