Skip to content

Commit

Permalink
docs: restructure scripts, update Setup.md docs for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Jan 6, 2025
1 parent 9307d63 commit 25a8891
Show file tree
Hide file tree
Showing 11 changed files with 67 additions and 295 deletions.
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ On a Linux-based machine with `bash` installed, run the script:
> However, if you run as root, a user svcfmtm will be created for you.
```bash
curl -L https://hotosm.github.io/fmtm-installer/install.sh -o install.sh
curl -L https://get.fmtm.dev -o install.sh
bash install.sh

# Then follow the prompts
Expand Down Expand Up @@ -123,7 +123,7 @@ a sample is located at `.env.example`.
This can be created interactively by running:

```bash
bash scripts/gen-env.sh
bash scripts/1-environment/gen-env.sh
```

> Note: If extra cors origins are required for testing, the variable
Expand Down
10 changes: 5 additions & 5 deletions docs/dev/Production.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ your own cloud server.
### Run the install script

```bash
curl -L https://hotosm.github.io/fmtm-installer/install.sh -o install.sh
curl -L https://get.fmtm.dev -o install.sh
bash install.sh

# Then follow the prompts
Expand All @@ -28,19 +28,19 @@ bash install.sh
Variables are set in `.env`.
Some can be updated manually, as required.

#### EXTRA_CORS_ORIGINS
##### EXTRA_CORS_ORIGINS

> If extra cors origins are required for testing, the variable
> `EXTRA_CORS_ORIGINS` is a set of comma separated strings, e.g.:
> <http://fmtm.localhost:7050,http://some.other.domain>
#### API_PREFIX
##### API_PREFIX

> It is also possible to use the API_PREFIX variable if the api
> is served under, e.g. /api on the domain.
> However, this isn't the recommended approach, and testing is minimal.
#### S3_ACCESS_KEY & S3_SECRET_KEY
##### S3_ACCESS_KEY & S3_SECRET_KEY

> In most circumstances these variables should be provided
> to authenticate with your S3 provider.
Expand All @@ -52,7 +52,7 @@ Some can be updated manually, as required.
> authenticated. S3_ACCESS_KEY and S3_SECRET_KEY should
> be set to blank strings in this case `=""`.
#### ODK\_ Variables
##### ODK\_ Variables

These can point to an externally hosted instance of ODK Central.

Expand Down
Loading

0 comments on commit 25a8891

Please sign in to comment.