ExternalVendorCode/open-balena
1
0
Fork 0
mirror of https://github.com/balena-io/open-balena.git synced 2024-12-18 21:27:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Open source software to manage connected IoT devices at scale
11 Commits 3 Branches 395 Tags 4.8 MiB
Shell 71%
Makefile 21.4%
Dockerfile 7.6%
55f60c60d2
Go to file
Rich Bayliss 55f60c60d2
env: Pass superuser credentials in the environment 
Allows the credentials to be passed via the environment in order
that the application can create the user on start up.

Change-type: patch
Signed-off-by: Rich Bayliss <rich@balena.io>
2018-11-07 10:10:26 +00:00
compose env: Pass superuser credentials in the environment 2018-11-07 10:10:26 +00:00
haproxy Initial commit 2018-10-27 22:34:05 +03:00
scripts env: Pass superuser credentials in the environment 2018-11-07 10:10:26 +00:00
src Initial commit 2018-10-27 22:34:05 +03:00
.gitignore Initial commit 2018-10-27 22:34:05 +03:00
CHANGELOG.md v0.0.4 2018-11-06 15:38:05 +02:00
LICENSE Initial commit 2018-10-27 22:34:05 +03:00
Makefile Initial commit 2018-10-27 22:34:05 +03:00
package-lock.json v0.0.2 2018-11-01 19:25:15 +01:00
README.md Automatically detect the correct NodeJS binary 2018-11-05 21:28:04 +02:00
repo.yml Add support for automatic versioning 2018-11-01 18:51:14 +02:00
Vagrantfile Initial commit 2018-10-27 22:34:05 +03:00
VERSION v0.0.4 2018-11-06 15:38:05 +02:00

README.md

Host requirements

  • Docker >= 18.05.0
  • Docker Compose >= 1.11
  • OpenSSL >= 1.0.0
  • Python >= 2.7 or >=3.4
  • NodeJS >= 4.0

Installation

Make sure you have the software listed above installed.

In a terminal, clone the project with:

$ git clone https://github.com/balena-io/open-balena.git

Change into the open-balena directory and run the configuration script. This will create a new directory, config, and generate appropriate SSL certificates and configuration for the instance.

$ ./scripts/quickstart

You may optionally configure the instance to run under a custom domain name. The default is openbalena.local. For example:

$ ./scripts/quickstart -d mydomain.com

For more available options, see the script's help:

$ ./scripts/quickstart -h

Start the instance with:

$ ./scripts/compose up -d

Stop the instance with:

$ ./scripts/compose stop

To remove all traces of the instance, run the following commands and finally delete the configuration folder.

WARNING: This will remove all data.

$ ./scripts/compose kill
$ ./scripts/compose down
$ docker volume rm openbalena_s3 openbalena_redis openbalena_db openbalena_registry

macOS & Windows

On macOS and Windows you need Vagrant. open-balena is not being tested with docker-machine. open-balena comes with an appropriate Vagrantfile for setting up the VM, installing dependencies and starting the platform.

  • Install Vagrant >= 2.0
  • $ vagrant plugin install vagrant-docker-compose
  • $ vagrant up

When provisioning completes and the VM has started, open-balena services should be running inside the VM. You will need to expose these services to the outside in order for them to be reachable by devices. To do so, you must setup DNS for the domain name you've deployed the instance as to point to the VM's IP address.