add C8Run documentation to self managed #4266
Merged
Conversation
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
conceptualshark
added
component:self-managed
|
👋 🤖 🤔 Hello! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
|
@conceptualshark I wasn't sure if you needed this reviewed, but I will just in case 👍 |
mesellings
previously approved these changes
Sep 9, 2024
| 2. Navigate to the new C8Run directory. | ||
| 3. Start C8Run by running `./start.sh` (or `.\c8run.exe start` on Windows) in your terminal. | ||
|
|
||
| When successful, a new Operate window will open automatically. |
There was a problem hiding this comment.
Suggested change
| When successful, a new Operate window will open automatically. | |
| When successful, a new Operate window automatically opens. |
NB suggestion
| When successful, a new Operate window will open automatically. | ||
|
|
||
| :::note | ||
| If C8Run fails to start, run the [shutdown script](/self-managed/setup/deploy/local/c8run.md/#shut-down-c8run) to end the current processes before running the start script again. |
There was a problem hiding this comment.
Suggested change
| If C8Run fails to start, run the [shutdown script](/self-managed/setup/deploy/local/c8run.md/#shut-down-c8run) to end the current processes before running the start script again. | |
| If C8Run fails to start, run the [shutdown script](/self-managed/setup/deploy/local/c8run.md/#shut-down-c8run) to end the current processes, and run the start script again. |
NB suggestion
| C8Run is not supported for production use. | ||
| ::: | ||
|
|
||
| The Camunda 8 Run Distribution, or C8Run, allows you to set up a local installation environment of Camunda 8 via a downloadable script. This page guides you through the manual installation of the Camunda 8 on a local or virtual machine. |
There was a problem hiding this comment.
Suggested change
| The Camunda 8 Run Distribution, or C8Run, allows you to set up a local installation environment of Camunda 8 via a downloadable script. This page guides you through the manual installation of the Camunda 8 on a local or virtual machine. | |
| You can use the Camunda 8 Run Distribution (C8Run) to set up a local installation environment of Camunda 8 via a downloadable script. This page guides you through the manual installation of the Camunda 8 Run Distribution on a local or virtual machine. |
NB suggestion
Comment on lines
28
to
38
| ## Install and start C8Run | ||
|
|
||
| 1. Download the [latest release of C8run](https://github.com/camunda/camunda/releases/tag/c8run-8.6.0-alpha3) for your operating system and architecture. Opening the .tgz file will extract the C8Run script into a new directory. | ||
| 2. Navigate to the new C8Run directory. | ||
| 3. Start C8Run by running `./start.sh` (or `.\c8run.exe start` on Windows) in your terminal. | ||
|
|
||
| When successful, a new Operate window will open automatically. | ||
|
|
||
| :::note | ||
| If C8Run fails to start, run the [shutdown script](#shut-down-c8run) to end the current processes before running the start script again. | ||
| ::: |
|
|
||
| ## Access Camunda components | ||
|
|
||
| All C8Run components can be accessed with the username/password combination `demo`/`demo`. |
There was a problem hiding this comment.
Suggested change
| All C8Run components can be accessed with the username/password combination `demo`/`demo`. | |
| All C8Run components can be accessed using the username/password combination `demo`/`demo`. |
| - Tasklist: `http://localhost:8080/tasklist` | ||
| - Operate: `http://localhost:8080/operate` | ||
|
|
||
| The following components do not have a web interface, but the URLs may be required for any additional configuration: |
There was a problem hiding this comment.
Suggested change
| The following components do not have a web interface, but the URLs may be required for any additional configuration: | |
| The following components do not have a web interface, but the URLs may be required for additional configuration: |
| - **Cluster endpoint:** `http://localhost:26500`, the location of your Zeebe Gateway | ||
| - **Authentication:** None | ||
|
|
||
| A success notification will display when complete. [Start a new process instance](/components/modeler/desktop-modeler/start-instance.md) to view your running process in Operate. |
There was a problem hiding this comment.
Suggested change
| A success notification will display when complete. [Start a new process instance](/components/modeler/desktop-modeler/start-instance.md) to view your running process in Operate. | |
| A success notification is shown when deployment is complete. [Start a new process instance](/components/modeler/desktop-modeler/start-instance.md) to view your running process in Operate. |
jessesimpson36
previously approved these changes
Sep 9, 2024
theburi
reviewed
Sep 9, 2024
| @@ -0,0 +1,90 @@ | |||
| --- | |||
| id: c8run | |||
| title: "Local installation with C8Run" | |||
There was a problem hiding this comment.
Can we use Camunda 8 Run (C8Run). C8Run looks like an abbreviation. It will also help with SEO.
There was a problem hiding this comment.
Late to the party 💃 but here I am!! 😆
Can we use Camunda 8 Run (C8Run). C8Run looks like an abbreviation. It will also help with SEO.
@conceptualshark you can consider using keywords in the page metadata for things like this.
keywords: ["C8Run"]
f482daf
mesellings
approved these changes
Sep 9, 2024
|
🧹 Preview environment for this PR has been torn down. |
|
|
||
| 1. Download the [latest release of Camunda 8 Run](https://github.com/camunda/camunda/releases/tag/c8run-8.6.0-alpha3) for your operating system and architecture. Opening the .tgz file extracts the Camunda 8 Run script into a new directory. | ||
| 2. Navigate to the new `c8run` directory. | ||
| 3. Start Camunda 8 Run by running `./start.sh` (or `.\c8run.exe start` on Windows) in your terminal. |
There was a problem hiding this comment.
I assume ./start.sh will work for both Linux and Mac users?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Product Hub link: https://github.com/camunda/product-hub/issues/2240
Adds the feature documentation for C8Run to the Self Managed docs. Does not include the getting started experience as part of this update (though the reusable component has been created for later implementation).
When should this change go live?
holdlabel or convert to draft PR)PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).