This document describes how to install OpenC3 using the openc3 shell scripts
The most commands can also take arguments. The current argument options when running are listed.
To build you can use an environment variable SSL_CERT_FILE or it will default to use a public curl ca file. When you run setup it copies the SSL_CERT_FILE and will place a copy in the root of the openc3 repo as cacert.pem. These are needed to build the docker containers.
If you're building and want to use a private Rubygems, NPM or APK server (e.g. Nexus) you can update the following environment variables: RUBYGEMS_URL, NPM_URL, APK_URL, and more in the .env file. Example values:
- ALPINE_VERSION=3.18
- ALPINE_BUILD=9
- RUBYGEMS_URL=https://rubygems.org
- NPM_URL=https://registry.npmjs.org
- APK_URL=http://dl-cdn.alpinelinux.org
>openc3.bat setup
$ openc3.sh setup
This will run the setup to make sure it has been run. It will build and run the minimal requirements for openc3. This will create a docker network and volumes if they do not already exist. Then run the containers.
>openc3.bat start
$ openc3.sh start
This will safely stop all openc3 containers and disconnect from all targets. This will NOT remove the docker network or volumes and thus all stored commands and telemetry are saved.
>openc3.bat stop
$ openc3.sh stop
Note this is destructive and if successful ALL stored commands and telemetry are deleted. This will remove all docker volumes which will delete ALL stored commands and telemetry! This will NOT stop running docker containers.
>openc3.bat cleanup
$ openc3.sh cleanup
This will build all new containers. If openc3 is being used you will have to stop and start the containers to get the new build.
>openc3.bat build
$ openc3.sh build
Tag and push docker containers into a docker repository.
>openc3.bat tag docker.io localhost:12345 openc3 latest
>openc3.bat push localhost:12345 openc3 latest
$ openc3.sh tag docker.io localhost:12345 openc3 latest
$ openc3.sh push localhost:12345 openc3 latest