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

Update installation.md #144

Merged
merged 1 commit into from
May 16, 2024
Merged

Update installation.md #144

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
44 changes: 27 additions & 17 deletions doc/docs/developer/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,9 @@ sidebar_position: 1

## Requirements

* Java JDK 11 (AZUL Zulu JDK recommended)
* Download: [https://www.azul.com/downloads/zulu](https://www.azul.com/downloads/zulu)
* Ubuntu Install Example
* Add Key: ```sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 0xB1998361219BD9C9```
* Add Repo: ```sudo apt-add-repository 'deb http://repos.azulsystems.com/ubuntu stable main'```
* Update Index: ```sudo apt-get update```
* Install: ```sudo apt-get install zulu-11```
* Make Default: ```echo 'export JAVA_HOME="/usr/lib/jvm/zulu-11-amd64/"' >> ~/.bashrc && . ~/.bashrc```
* Java JDK 17
* Git
* ```sudo apt-get install git```
* Docker

## Toolchain Setup

Expand All @@ -49,6 +42,29 @@ sudo chown -R $USER $BCO_DIST
chmod -R 750 $BCO_DIST
```

## Setup Middleware
### Setup Network
Setup a dedicated bco network for security reasons.
```bash
docker network create bco-net
```

### MQTT Broker Setup

```bash
echo -e "allow_anonymous true\nlistener 1883" > $HOME/.mosquitto.conf && \
docker run \
--name mqtt-broker \
--network=bco-net \
--publish 1883:1883 \
--volume $HOME/.mosquitto.conf:/mosquitto/config/mosquitto.conf \
--restart=always \
--log-driver=local \
--detach \
eclipse-mosquitto
```


## BCO Installation

After preparing the toolchain and middleware we need to prepare our workspace.
Expand All @@ -74,11 +90,8 @@ cd developer.tools
Download the bco main repository into your development workspace.
```
cd ~/workspace/openbase
git clone -b stable https://github.com/openbase/bco.git
git clone https://github.com/openbase/bco.git
```
:::info INFO
We recommend to checkout and install the ```dev``` branch in order to start the development of new components.
:::

### Download and Prepare BCO Submodules

Expand All @@ -95,9 +108,6 @@ If the workspace is prepared, we can build bco by using the ```install``` script
cd ~/workspace/openbase/bco
./install.sh
```
:::info INFO
The initial installation can take a while, so grab a coffee and relax while the scripts do the work.
:::

Now everything should be ready to start the development of new bco components and apps. We recommend to use IntelliJ as IDE for BCO.
Open ```~/workspace/openbase/bco``` in the IDE or just execute ```idea ~/workspace/openbase/bco``` in case IntelliJ is provided by your shell.
Expand Down Expand Up @@ -133,4 +143,4 @@ git clone https://github.com/openbase/bco.registry.demo-db db

### How to Restore a Backup

To restore an already existing bco setup, just place the related ```db``` directory within ```~/.config/bco/var/registry```.
To restore an already existing bco setup, just place the related ```db``` directory within ```~/.config/bco/var/registry```.
Loading