-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
OZ-450: Generic README linking to docs & community resources.
- Loading branch information
Showing
1 changed file
with
11 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,66 +1,14 @@ | ||
| # Ozone - The Docker Compose Project | ||
| <p align="center"> | ||
| <a href="https://docs.ozone-his.com/"><img src="https://www.ozone-his.com/wp-content/uploads/2021/11/Ozone-Logo.png" alt="Ozone" width="30%"/></a> | ||
| </p> | ||
|
|
||
| 👉 **Recommended:** Please refer to the [Ozone](https://github.com/ozone-his/ozone) repository to try and run Ozone 👈 | ||
| <h3 align="center">Health Information System</h3> | ||
|
|
||
| While is not the recommended way, developpers can also run Ozone directly from this project. See instructions below. | ||
|
|
||
| ## (option 1) Try Ozone FOSS in Gitpod | ||
|
|
||
| [](https://gitpod.io/#https://github.com/ozone-his/ozone-docker-compose) | ||
|
|
||
| It may take some time to setup Ozone for the first time, so hang tight :hourglass_flowing_sand: | ||
|
|
||
| When ready Gitpod will launch the tab for OpenMRS 3. | ||
|
|
||
| ## (option 2) Try Ozone locally using the embedded Nginx reverse proxy | ||
|
|
||
| Clone the repo | ||
| ```bash | ||
| git clone https://github.com/ozone-his/ozone-docker-compose | ||
| cd ozone-docker-compose | ||
| ``` | ||
|
|
||
| Build | ||
| ```bash | ||
| scripts/mvnw clean package | ||
| ``` | ||
|
|
||
| Run | ||
| ```bash | ||
| source target/go-to-scripts-dir.sh | ||
| ./fetch-ozone-distro.sh 1.0.0-SNAPSHOT # Replace by the version of your choice | ||
| ./start-demo.sh | ||
| ``` | ||
|
|
||
| ## (option 3) Try Ozone locally assuming Traefik is running on the host | ||
|
|
||
|
|
||
| Clone | ||
| ```bash | ||
| git clone https://github.com/ozone-his/ozone-docker-compose | ||
| cd ozone-docker-compose | ||
| ``` | ||
|
|
||
| Build | ||
| ```bash | ||
| scripts/mvnw clean package | ||
| ``` | ||
|
|
||
| Run | ||
| ```bash | ||
| source target/go-to-scripts-dir.sh | ||
| ./fetch-ozone-distro.sh 1.0.0-SNAPSHOT # Replace by the version of your choice | ||
| export TRAEFIK="true" | ||
| ./start-demo.sh | ||
| ``` | ||
|
|
||
| ## Browse Ozone | ||
|
|
||
| Once complete, the startup script will output the URLs to access the services in the terminal. | ||
|
|
||
| For example: | ||
|  | ||
| Ozone FOSS requires you to log into each component separately. | ||
|
|
||
| 💡 **Did you know?** Ozone Pro comes with single sign-on (SSO) and all its integration layer is secured with OAuth2. | ||
| <p align="center"> | ||
| Welcome to Ozone's open-source repositories! | ||
| <br/>Engage with the Ozone community and access useful resources below: | ||
| </p> | ||
|
|
||
| <h3 align="center"> | ||
| <a href="https://docs.ozone-his.com/">Docs</a> • <a href="https://talk.openmrs.org/c/software/ozone-his/70">Forum</a> • <a href="https://openmrs.slack.com/archives/C02PYQD5D0A">Chat Room</a> | ||
| </h3> |