Skip to content

Commit

Permalink
OZ-450: Updated Quick Start and added implementer guide placeholder. (#2
Browse files Browse the repository at this point in the history
)

---------
Co-authored-by: Dimitri R <dimitri@mekomsolutions.com>
  • Loading branch information
rbuisson committed Mar 5, 2024
1 parent 43ca51b commit a16cb41
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 206 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.DS_Store
.DS_Store
site/
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Ozone Docs

This projects drives the content of https://docs.ozone-his.com
This projects drives the content of https://docs.ozone-his.com
Binary file added docs/assets/images/gitpod-list-services.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/impl-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Implementer Guide

!!! info "🚧 Work In Progress"
Coming soon:
- Using the Ozone Maven archetype
- Using the Maven parent
- Override inherited configurations (OpenMRS backend config, OpenMRS frontend config, Odoo config...)
63 changes: 34 additions & 29 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,64 @@
# Quick Start
??? question "Wait, have you checked the online demo of Ozone Pro? :thinking:"

Before diving into the Quick Start or implementer guides, visit <a href="https://www.ozone-his.com">our website</a> and click **Try Demo** to explore the official Ozone Pro online demo.

## Run Ozone
# Quick Start

=== ":fontawesome-solid-location-dot: locally"
=== ":fontawesome-solid-location-dot: Locally"

Three lines in a terminal:
Only three commands in a terminal:

Download and install Ozone
```bash
curl -s https://raw.githubusercontent.com/ozone-his/ozone/main/scripts/install-latest.sh | bash /dev/stdin
```

Run
```
```bash
cd ozone/run/docker/scripts/
```

```bash
./start-demo.sh
```

!!! warning ""

:fontawesome-regular-hourglass-half: It may take some time to download and setup Ozone for the first time.

=== ":simple-gitpod: Gitpod"
Then, start browsing Ozone. This requires you to log into each component separately:

One click here:
| **HIS Component** | **URL** |
|-------------------|-------------------------------------------------------------------------------------------|
| OpenMRS 3 | <a href="http://localhost/openmrs/spa" target="_blank">http://localhost/openmrs/spa</a> |
| SENAITE | <a href="http://localhost:8081/senaite" target="_blank">http://localhost:8081/senaite</a> |
| Odoo | <a href="http://localhost:8069" target="_blank">http://localhost:8069</a> |
| Superset | <a href="http://localhost:8088" target="_blank">http://localhost:8088</a> |

[![](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ozone-his/ozone/)

!!! info ""
=== ":simple-gitpod: Gitpod"

When ready Gitpod will launch the browser tab for OpenMRS 3.
Just one click:

[![](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ozone-his/ozone/)

!!! warning ""

## <a href="#browse">Browse Ozone</a>
:fontawesome-regular-hourglass-half: It may take some time to download and setup Ozone for the first time.

Then, start browsing Ozone. This requires you to log into each component separately:
Gitpod will automatically launch a new tab for OpenMRS 3.

=== ":simple-apache: Nginx (default)"
You can navigate to other Ozone HIS components via the PORTS tab of the Gitpod window:

| HIS Component | URL | Username | Password |
|-------------------|--------------------------------|----------|----------|
| OpenMRS 3 | http://localhost/openmrs/spa | admin | Admin123 |
| SENAITE | http://localhost:8081/senaite | admin | password |
| Odoo | http://localhost:8069 | admin | admin |
| Superset | http://localhost:8088 | admin | password |
![Ozone services started](assets/images/gitpod-list-services.png)

=== ":simple-traefikproxy: Traefik"
Each component will require you to log in separately with their own credentials:

| HIS Component | URL | Username | Password |
|-------------------|-------------------------------------------|----------|----------|
| OpenMRS 3 | https://emr-172-17-0-1.traefik.me | admin | Admin123 |
| SENAITE | https://lims-172-17-0-1.traefik.me | admin | password |
| Odoo | https://erp-172-17-0-1.traefik.me | admin | admin |
| Superset | https://analytics-172-17-0-1.traefik.me | admin | password |
| **HIS Component** | **Username** | **Password** |
|-------------------|--------------|--------------|
| OpenMRS 3 | admin | Admin123 |
| SENAITE | admin | password |
| Odoo | admin | admin |
| Superset | admin | password |

!!! tip "**Did you know?**"

Ozone Pro comes with [single sign-on and](/users/sso) all its interoperability layer is secured with OAuth2.
Ozone Pro comes with [single sign-on](/users/sso) and all its interoperability layer is secured with OAuth2.
173 changes: 0 additions & 173 deletions docs/manual-setup.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@
--md-primary-fg-color: #007d79;
--md-primary-fg-color--light: #007d79;
--md-primary-fg-color--dark: #007d79;
}
}
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ repo_name: ozone-his/ozone
nav:
- Implementers:
- Quick Start: 'index.md'
- Manual Setup: 'manual-setup.md'
- Implementer Guide: 'impl-guide.md'
- Users:
- Overview: 'users/overview.md'
- Single Sign-on: 'users/sso.md'
Expand Down

0 comments on commit a16cb41

Please sign in to comment.