Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update running-locally-docker.md #202

Merged
merged 1 commit into from
Nov 17, 2022
Merged

Update running-locally-docker.md #202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 26 additions & 22 deletions docs/getting-started/install/running-locally-docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,34 @@ sidebar_position: 2

Orkes publishes containers to [DockerHub](https://hub.docker.com/) under [orkesio](https://hub.docker.com/orgs/orkesio/repositories) organization.

## Orkes Cloud Build for Local development and testing
Available to the users of Orkes Cloud, with all the features of Orkes cloud on your local machine! (Requires subscription to Orkes Cloud)
## Orkes Cloud Build for Local Development and Testing

Available to the users of Orkes Cloud, with all the Orkes cloud features on your local machine. Requires subscription to Orkes Cloud.

Orkes publishes *orkes-conductor-standalone* docker container that can be used for local development and testing.

The container is self-contained with full orkes development stack that contains persistent store, Orkes server and system workers.
The container is self-contained with the full Orkes development stack that contains a persistent store, Orkes server, and system workers.

:::note
The standalone container is only meant for local development and is not suitable for running any production workload.

*orkes-conductor-standalone* is available to the Orkes Customers and needs an authorization token to download the container.
:::


### Obtaining Authorization Token​

> **Note**
> The standalone container is only meant for the local development and is not suitable for running any production workload
>
> *orkes-conductor-standalone* is available to the Orkes Customers and needs an authorization token to download the container.
Please reach out to your Orkes contact to obtain the token.

### Download and Run the Container​

### Obtaining the authorization token
Please reach out to your Orkes contact for obtaining the token.
Log in to the Docker Hub using Orkes Access Account. When prompted for the password, use the access token provided by the Orkes team.
:::note
* If you do not have an access token (or have lost it), please contact support@orkes.io to issue a new one.
* Standard security measures should be used within the organization when storing and distributing the access token.
:::

### Download and run the container
Login to the Docker Hub using Orkes Access Account. When prompted for the password, use the access token provided by the Orkes team.
> **Note**
> If you do not have access token (or have lost it), please contact support@orkes.io to issue a new one
>
> Standard security measures should be used within the organization when storing and distributing the access token.
>
>
#### Download and run the latest container build
#### Download and Run the Latest Container Build​

```shell
export orkes_access_key=<ACCESS_KEY_PROVIDED_BY_ORKES>
Expand All @@ -44,10 +48,10 @@ docker run -i -p 8080:8080 -p 3000:5000 --mount source=redis,target=/redis \
--mount source=postgres,target=/pgdata orkesio/orkes-conductor-standalone:latest
```

###### Access Conductor UI
#### Access Conductor UI

Navigate to [http://localhost:3000](http://localhost:3000)
Navigate to [http://localhost:3000](http://localhost:3000).

###### Access Swagger API Documentation
#### Access Swagger API Documentation

[http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config#/](http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config#/)
[http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config#/](http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config#/).