forked from cerc-io/stack-orchestrator
Add warning on user mode install
This commit is contained in:
parent
543afe1808
commit
d138bb1a72
14
README.md
14
README.md
@ -3,9 +3,7 @@
|
|||||||
Stack Orchestrator allows building and deployment of a Laconic stack on a single machine with minimial prerequisites.
|
Stack Orchestrator allows building and deployment of a Laconic stack on a single machine with minimial prerequisites.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
### User Mode
|
### Prerequisites
|
||||||
User mode runs the orchestrator from a "binary" single-file release and does not require special Python environment setup. Use this mode unless you plan to make changes to the orchestrator source code.
|
|
||||||
#### Prerequisites
|
|
||||||
Stack Orchestrator is a Python3 CLI tool that runs on any OS with Python3 and Docker. Tested on: Ubuntu 20/22.
|
Stack Orchestrator is a Python3 CLI tool that runs on any OS with Python3 and Docker. Tested on: Ubuntu 20/22.
|
||||||
|
|
||||||
Ensure that the following are already installed:
|
Ensure that the following are already installed:
|
||||||
@ -30,7 +28,13 @@ Ensure that the following are already installed:
|
|||||||
# see https://docs.docker.com/compose/install/linux/#install-the-plugin-manually for further details
|
# see https://docs.docker.com/compose/install/linux/#install-the-plugin-manually for further details
|
||||||
# or to install for all users.
|
# or to install for all users.
|
||||||
```
|
```
|
||||||
#### Install
|
|
||||||
|
### User Mode Install
|
||||||
|
|
||||||
|
User mode runs the orchestrator from a "binary" single-file release and does not require special Python environment setup. Use this mode unless you plan to make changes to the orchestrator source code.
|
||||||
|
|
||||||
|
*NOTE: User Mode is currently broken, use "Developer mode" described below for now.*
|
||||||
|
|
||||||
1. Download the latest release from [this page](https://github.com/cerc-io/stack-orchestrator/tags), into a suitable directory (e.g. `~/bin`):
|
1. Download the latest release from [this page](https://github.com/cerc-io/stack-orchestrator/tags), into a suitable directory (e.g. `~/bin`):
|
||||||
```
|
```
|
||||||
$ cd ~/bin
|
$ cd ~/bin
|
||||||
@ -56,7 +60,7 @@ Ensure that the following are already installed:
|
|||||||
deploy-system deploy a stack
|
deploy-system deploy a stack
|
||||||
setup-repositories git clone the set of repositories required to build...
|
setup-repositories git clone the set of repositories required to build...
|
||||||
```
|
```
|
||||||
### Developer mode
|
### Developer mode Install
|
||||||
Suitable for developers either modifying or debugging the orchestrator Python code:
|
Suitable for developers either modifying or debugging the orchestrator Python code:
|
||||||
#### Prerequisites
|
#### Prerequisites
|
||||||
In addition to the binary install prerequisites listed above, the following are required:
|
In addition to the binary install prerequisites listed above, the following are required:
|
||||||
|
Loading…
Reference in New Issue
Block a user