Skip to content

Commit

Permalink
docs: tweak install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Nov 9, 2023
1 parent ceb02a6 commit 57e7ef0
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ bash install.sh
```

> Note: it is best to run this script as a user other than root.
>
> However, if you run as root, a user svcfmtm will be created for you.
## Manual Way
Expand Down Expand Up @@ -123,14 +124,14 @@ This is the easiest way to get started with FMTM.
Docker runs each service inside **containers**, fully isolated from your
host operating system.

##### Prerequisite
#### Prerequisite

You will need to [Install Docker](https://docs.docker.com/engine/install/)
and ensure that it is running on your local machine.

Then from the command line, navigate to the top level directory of the FMTM project.

##### Select the install type
#### Select the install type

Determine the what type of FMTM install you would like:

Expand Down Expand Up @@ -159,15 +160,15 @@ export GIT_BRANCH={your_selection}
export GIT_BRANCH=development
```

##### Pull the Images
#### Pull the Images

```bash
docker compose -f "docker-compose.${GIT_BRANCH}.yml" pull
```

> This will pull the latest containers for the branch you selected.
##### Build the Frontend
#### Build the Frontend

Before we can run, you need to build your version of the frontend.

Expand All @@ -177,7 +178,7 @@ This is because the frontend contains variable specific to your deployment.
docker compose -f "docker-compose.${GIT_BRANCH}.yml" build ui
```

##### Start the Containers
#### Start the Containers

```bash
docker compose -f "docker-compose.${GIT_BRANCH}.yml" up -d
Expand All @@ -195,6 +196,7 @@ http://fmtm.localhost:7050
```

> Note: If those link doesn't work, check the logs with `docker logs fmtm-api`.
>
> Note: Use `docker ps` to view all container names.
### Setup ODK Central User (Optional)
Expand All @@ -218,7 +220,9 @@ docker-compose exec central odk-cmd --email YOUREMAIL@ADDRESSHERE.com user-promo
If running a local test version, test data is available to get started quickly.

- Navigate to the `import-test-data` endpoint in the API docs page:
<http://api.fmtm.localhost:7050/docs#/debug/import_test_data_debug_import_test_data_get>

<http://api.fmtm.localhost:7050/docs#/debug/import_test_data_debug_import_test_data_get>

- Click `Try it out`, then `execute`.

### Check Authentication (Optional)
Expand Down

0 comments on commit 57e7ef0

Please sign in to comment.