-
Notifications
You must be signed in to change notification settings - Fork 33
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
62 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,65 +1,14 @@ | ||
| # Ozone | ||
| <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> | ||
|
|
||
| > The enterprise-grade health information system that augments OpenMRS 3 | ||
| <h3 align="center">Health Information System</h3> | ||
|
|
||
| # Quick start | ||
| <p align="center"> | ||
| Welcome to Ozone's open-source repositories! | ||
| <br/>Engage with the Ozone community and access useful resources below: | ||
| </p> | ||
|
|
||
| ## (option 1) Try Ozone FOSS in Gitpod | ||
|
|
||
| [](https://gitpod.io/#https://github.com/ozone-his/ozone) | ||
|
|
||
| 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 | ||
| ```bash | ||
| git clone https://github.com/ozone-his/ozone | ||
| cd ozone | ||
| ``` | ||
|
|
||
| Build | ||
| ```bash | ||
| scripts/mvnw clean package | ||
| ``` | ||
|
|
||
| Run | ||
| ```bash | ||
| source target/go-to-scripts-dir.sh | ||
| ./start-demo.sh | ||
| ``` | ||
|
|
||
| Tip: After running `source target/go-to-scripts-dir.sh` command you can use `popd` to easily move back to the root directory, if needed. | ||
|
|
||
|
|
||
| ## (option 3) Try Ozone locally assuming Traefik is running on the host | ||
|
|
||
| Clone | ||
| ```bash | ||
| git clone https://github.com/ozone-his/ozone | ||
| cd ozone | ||
| ``` | ||
|
|
||
| Build | ||
| ```bash | ||
| scripts/mvnw clean package | ||
| ``` | ||
|
|
||
| Run | ||
| ```bash | ||
| source target/go-to-scripts-dir.sh | ||
| 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. | ||
| <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> |