QT/sure
1
0
Fork 0
mirror of https://github.com/we-promise/sure.git synced 2026-04-18 03:24:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

MERGE doc/adding_https_info INTO main (#709)

Browse Source 
* Suggest to use .env.example

it's easier to start with a pre-done file than search for info about each configuration

* added paragraph to tell how to activate https

* fix type.

As there was 2 space, I assumed there should be a line break

* Corrects minor typos in HTTPS documentation

Addresses a couple of minor typographical errors in the HTTPS documentation section, improving clarity and readability for users setting up HTTPS.

* Clarifies .env setup in Docker documentation

Corrects grammar and improves clarity in the Docker documentation regarding obtaining the `.env.example` file for initial configuration.

* Fixes typo in HTTPS documentation

Corrects a grammatical error in the Docker HTTPS setup guide, improving clarity for users configuring SSL.
This commit is contained in:
Nicolas PERNOT
2026-01-19 19:36:14 +01:00
committed by GitHub
parent 877abcf4ce
commit 73c816559d
1 changed files with 20 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/hosting/docker.md
View File

@@ -51,7 +51,8 @@ At this point, the only file in your current working directory should be `compos
### Step 3 (optional): Configure your environment
By default, our `compose.example.yml` file runs without any configuration. That said, if you would like extra security (important if you're running outside of a local network), you can follow the steps below to set things up.
By default, our `compose.example.yml` file runs without any configuration.
That said, if you would like extra security (important if you're running outside of a local network), you can follow the steps below to set things up.
If you're running the app locally and don't care much about security, you can skip this step.
@@ -59,10 +60,10 @@ If you're running the app locally and don't care much about security, you can sk
In order to configure the app, you will need to create a file called `.env`, which is where Docker will read environment variables from.
To do this, run the following command:
To do this, you should get our .env.example as a starting point:
```bash
touch .env
curl -o .env https://raw.githubusercontent.com/we-promise/sure/main/.env.example
```
#### Generate the app secret key
@@ -94,6 +95,22 @@ SECRET_KEY_BASE="replacemewiththegeneratedstringfromthepriorstep"
POSTGRES_PASSWORD="replacemewithyourdesireddatabasepassword"
```
#### Using HTTPS
Assuming you want to access your instance from the internet, you should have secured your URL address with an SSL certificate.
The Docker instance runs in plain HTTP and you need to tell it that you are redirecting your HTTPS stream to the HTTP one.
To do this, edit the `compose.yml` file and find the line stating:
```yaml
RAILS_ASSUME_SSL: "false"
```
and change it to `true`
```yaml
RAILS_ASSUME_SSL: "true"
```
### Step 4: Run the app
You are now ready to run the app. Start with the following command to make sure everything is working: