Stork Installation Instructions
NOTE: This page is being migrated to Stork ARM and is outdated. See Stork ARM at readthedocs for the up to date information.
Below are some system specific notes.
On Ubuntu 20, you need to install couple packages first:
$ sudo apt install rake docker docker-compose python3-sphinx-rtd-theme openjdk-11-jre-headless
Get the stork sources, then:
$ rake docker_up
This is by far the simplest method. However, it requires the docker environment and Java to be up and running.
- Make sure that postgresql is installed:
$ sudo apt install postgresql postgresql-client $ sudo systemctl start postgresql
- You may need to modify pg_hba.conf in /etc/postgresql (may be in 10/main subdir) and tweak the access rights, so the the unix account running Stork code will be able to connect as stork user in postgres.
local all all password host all all 127.0.0.1/32 password host all all ::1/128 password
- Create the database, stork user and assign necessary permissions:
# su - postgres postgres@ubuntu:~$ psql postgres psql (10.10 (Ubuntu 10.10-0ubuntu0.18.04.1)) Type "help" for help. postgres=# CREATE USER stork WITH PASSWORD 'stork'; CREATE ROLE postgres=# CREATE DATABASE stork; CREATE DATABASE postgres=# GRANT ALL PRIVILEGES ON DATABASE stork TO stork; GRANT postgres=# \c stork postgres=# CREATE EXTENSION pgcrypto; CREATE EXTENSION postgres=# \q
- Install Rake:
sudo apt install rake
- Build the code:
rake build_agent build_backend build_migrations build_server build_ui
- Initialize the db:
$ backend/cmd/stork-db-migrate/stork-db-migrate init $ backend/cmd/stork-db-migrate/stork-db-migrate up
Run server in one console:
Run the UI in another console:
Run the agent in the third console:
You can now connect to http://localhost:4200, log in and connect your machine available at localhost:8888.
MacOS is not officially supported. Here are some instructions for developers to run Stork.
NOTE: As of Nov 16, this requires changes from 87-macos. See !26.
- Install postgresql:
brew install postgresql
- Make sure the service is started:
brew services listand
brew services start postgresql
psql postgresand create the user and database:
$ psql postgres psql (11.5) Type "help" for help. postgres=# CREATE USER stork WITH PASSWORD 'stork'; CREATE ROLE postgres=# CREATE DATABASE stork; CREATE DATABASE postgres=# GRANT ALL PRIVILEGES ON DATABASE stork TO stork; GRANT postgres=# \c stork You are now connected to database "stork" as user "thomson". stork=# create extension pgcrypto; CREATE EXTENSION
- (optional) Temporarily store the password in STORK_DATABASE_PASSWORD. Otherwise many of the following steps will ask about it:
- Initialize the DB:
$ backend/cmd/stork-db-migrate/stork-db-migrate init
- Upgrade the database:
$ backend/cmd/stork-db-migrate/stork-db-migrate up
- Run the server:
- (in another console) Run the UI frontend:
- (in another console) Run the agent:
- Click add new machine, use localhost:8888. This will at the agent you ran in the step 9 above.
The following commands can be used to install Stork agent on FreeBSD. This procedure has been tried on 12.1-RELEASE-p3
- pkg install rubygem-rake ruby
- pkg install git
- git clone https://gitlab.isc.org/isc-projects/stork.git
- sudo pkg install protobuf
- mkdir -p tools/3.11.2/bin
- cd tools/3.11.2/bin
- ln -s
- rake build_agent