Installation

Prerequisites

PostgreSQL 10 and above (Earlier versions should be supported. However, testing is performed in 10)
Rabbit MQ 3.8.3
Node v12.16.*

via Github

Ensure you have read the Prerequisites section.

Prerequisites for Github

yarn 1.22.x (npm install -g yarn)
Go 1.15.x
Ruby 2.7.1 (with bundler installed)

Installing via Github requires you to download all the microservice repositories individually. Including the interface, there are ten services you’ll need to install and run - this will take some time, and installing through Docker is recommended.

RabbitMQ

Assuming that you have RabbitMQ install correctly (and added to PATH), you need add yourself a user to rabbitmq.

Create a user

sudo rabbitmqctl add_user oop somepassword
sudo rabbitmqctl list_permissions --vhost /
sudo rabbitmqctl set_permissions -p / oop ".*" ".*" ".*"

Ensure this is reflected in OOP_AMQP_ADDRESS connection string environment variable.

.global-env

A file including all environment variables will need to be created outside of any of the microservice directories. A symlink will need to be created in each directory to mirror .global-env, the command for this will be included in the instructions for each microservice individually.

`.global-env`

NODE_ENV=production
RAILS_ENV=production

# All repos
OOP_AMQP_ADDRESS=amqp://oop:somepasssword@localhost
RABBITMQ_URL=amqp://oop:somepassword@localhost
OOP_ERROR_EXCHANGE_NAME=oop.errors
OOP_JSON_ERROR_Q=oop.errors.json
OOP_EXCHANGE_NAME=oop
OOP_QUEUE_PREFETCH_LIMIT=5

# Gateway
OOP_GATEWAY_OUTPUT_Q=oop.noauth.raw_messages
OOP_LISTEN_PORT=3000
OOP_DB_ADDRESS=http://admin:admin@localhost:5984

# Authenticator
OOP_AUTHENTICATOR_INPUT_Q=oop.noauth.raw_messages
OOP_AUTHENTICATOR_OUTPUT_Q=oop.hasauth.messages
OOP_CORE_TOKEN=foobar
OOP_CORE_DEVICE_UPDATE_EXCHANGE=oop.core.devices

# Tempr
OOP_TEMPR_INPUT_Q=oop.hasauth.messages
OOP_TEMPR_OUTPUT_Q=oop.hasauth.temprs
OOP_CORE_API_URL=http://{CORE_IP_ADDRESS}:9001/services/v1

# Scheduler
OOP_SCHEDULER_OUTPUT_Q=oop.hasauth.messages

# Renderer
OOP_RENDERER_INPUT_Q=oop.hasauth.temprs
OOP_ENDPOINTS_EXCHANGE_NAME=oop.endpoints
OOP_ENDPOINT_Q=oop.endpoints

# Endpoints HTTP
OOP_ENDPOINTS_HTTP_OUTPUT_Q=oop.hasauth.relay
OOP_REQUEST_TIMEOUT=1000
OOP_ENDPOINTS_HTTP_MAX_RETRIES=3

# Relay
OOP_RELAY_INPUT_Q=oop.hasauth.relay
OOP_RECURSIVE_TEMPR_Q=oop.hasauth.temprs
OOP_CORE_RESPONSE_Q=oop.core.transmissions

# Core
OOP_AMQP_ADDRESS=amqp://localhost
OOP_RENDERER_PATH=/path/to/renderer/

OOP_CORE_SCHEME=http://
OOP_CORE_PORT=9001
OOP_CORE_PATH=/

PORT=9001

OOP_CORE_INTERFACE_SCHEME=http://
OOP_CORE_INTERFACE_PORT=80
OOP_CORE_INTERFACE_PATH=/
OOP_CORE_FROM_ADDRESS=example@mail.co.uk

# Mail setup
OOP_CORE_FROM_ADDRESS=
OOP_CORE_SMTP_ADDRESS=
OOP_CORE_SMTP_PORT=25
OOP_CORE_SMTP_DOMAIN=
OOP_CORE_SMTP_USER_NAME=
OOP_CORE_SMTP_PASSWORD=
OOP_CORE_SMTP_AUTHENTICATION=
OOP_CORE_SMTP_ENABLE_STARTTLS_AUTO=

DATABASE_HOST=localhost
POSTGRES_USER=postgres
POSTGRES_PASSWORD=password
POSTGRES_DB=oop_core_development

SECRET_KEY_BASE={SECRETKEY}

oop-core

Clone the application git clone http://github.com/open-interop/oop-core.git In the app directory install all dependencies using bundle install Create a symlink to the .env file created earlier - ln -nfs /path/to/.global-env /path/to/oop-core/.env Ensure all variables are set up correctly in the config directory:

`database.yml`

# config/database.yml

default: &default
  adapter: postgresql
  encoding: unicode
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  host: <%= ENV.fetch('DATABASE_HOST') %>
  username: <%= ENV.fetch('POSTGRES_USER') %>
  password: <%= ENV.fetch('POSTGRES_PASSWORD') %>
  database: <%= ENV.fetch('POSTGRES_DB') %>
  variables:
    statement_timeout: 5000

production:
  <<: *default

`storage.yml`

# config/storage.yml

local:
  service: Disk
  root: <%= Rails.root.join("storage") %>

`secrets.yml`

# config/secrets.yml

production:
  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

Create the database - bundle exec rails db:create Run the database migrations - bundle exec rails db:migrate

For the initial setup run - bin/rails open_interop:setup_initial_account

To start core run - bin/rails server -b HOSTNAME -p 9001 where HOSTNAME is the host core is accessible from - this should be reflected in the .env file above

oop-core includes the transmission queue, to start this run - bin/rails runner TransmissionQueue.retrieve_transmissions

Microservices:

The following services can all be installed and set up in exactly the same way, cloning the repo and using yarn to install any dependencies.

oop-gateway

git clone http://github.com/open-interop/oop-gateway.git

cd oop-gateway

ln -nfs /path/to/.global-env /path/to/oop-gateway/.env

yarn install