synereo

Contents:

• Instructions for Running a Synereo Node
• Instructions for Developers

Instructions for Running a Synereo Node

WARNING

This is experimental, pre-release software and should be used for testing purposes only.

While the software is in pre-release phase, there is a high likelihood of data loss and features will change without notice.

Requirements

• Basic knowledge of Docker
  • New users should start here
• A machine capable of running Docker, with at least 4 GB RAM (> 8 GB recommended)
  • For Linux users, installation information is available here
  • For Mac users, system requirements and installation information is available here
  • For Windows users, system requirements and installation information is available here

Installation

Step 1. If you haven't already done so, install Docker. See above for platform-specific information.

Step 2. Open a terminal and pull the node image from Docker Hub.

docker pull synereo/synereo-node

First Time Usage

After pulling the image, run the following command, substituting <parts-like-this> with meaningful values:

docker run -itd -p 443:9876 \
  -e EMAIL_SMTP_SERVER=<invitation-email-smtp-server> \
  -e EMAIL_AUTH_USERNAME=<invitation-email-username> \
  -e EMAIL_AUTH_PASSWORD=<invitation-email-password> \
  -e EMAIL_FROM_ADDRESS=<invitation-email-address> \
  --dns <dns-server> \
  --name <container-name> \
  synereo/synereo-node

Guide to meaningful values::

• <invitation-email-smtp-server>
  • Description: <HOST>:<PORT> of the SMTP server for the email address from which your node should send invitations
  • Example value: smtp.googlemail.com:465
• <invitation-email-username>
  • Description: Username for the email address from which your node should send invitations
  • Example value: alice.the.node.operator
• <invitation-email-password>
  • Description: Password for the email address from which your node should send invitations
  • Example value: thisismyterriblepassword
• <invitation-email-address>
  • Description: Email address from which your node should send invitations
  • Example value: [email protected]
• <dns-server>
  • Description: Domain Name Server for your node to use to send its email invitations
  • Example value: 8.8.8.8
• <container-name>
  • Description: A name for Docker to give to your node's container, so that you can easily refer to the container with other commands
  • Example value: synereo-node-01

Accessing the Synereo Social Platform

To access the application, you must first know the IP address of your running container.

Alternatively, on Linux, you can get the IP address of your running container using the following command:

docker inspect --format '{{ .NetworkSettings.IPAddress }}' synereo-node-01

You can then access the application with your web browser at:

https://<Default IP Address>/

For example, on Windows this would be:

https://192.168.99.100/

NOTE: When accessing the application for the first time, your browser will warn you that the site is insecure. This happens because the pre-release version of this software uses a self-signed TLS certificate. You should follow your browser's instructions about approving the site's certificate.

Congratulations!, you can now log in using the administrator account:

To register as a new user, see the instructions here.

NOTE: This username and password can be changed by editing the eval.conf file inside the running container.

Stopping the Container

To stop the container:

docker stop <container-name>

General Usage

To restart the container:

docker start <container-name>

Further Help

Please visit the #docker-testing channel on our Slack.

Instructions for Developers

Requirements

To work with the projects in this repository you will need:

• MongoDB, version 2.6.12 (also tested with version 2.4.14, 3.2.9)
  • available at https://www.mongodb.com/download-center (go to "Previous Releases")
• Erlang, version 15B03 (also tested with version R14B04) (required to run RabbitMQ)
  • available at https://www.erlang-solutions.com/resources/download.html
• RabbitMQ, version 3.0.2 (also tested with version 2.7.1)
  • available at http://www.rabbitmq.com/download.html (go to "Older Versions")
• Java Development Kit (JDK), version 8 (also tested with version 7)
  • available at http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
  • alternatively, the OpenJDK can be installed using most common package managers.
• sbt
  • available at http://www.scala-sbt.org/download.html

To build a Docker image you will need:

• Docker
  • available at https://www.docker.com/products/docker

Additionally, to run the Agent Service test suites you will need:

• Memcached, latest stable version
  • available at https://memcached.org/downloads

Usage

After installing the these dependencies, you can clone this repo and run tasks using sbt:

$ git clone https://github.com/synereo/synereo.git
  ...
$ cd synereo
$ sbt "gloseval/run gencert --self-signed"
  ...

# Run a GLoSEval server
$ sbt gloseval/run
  ...

# Run the SpecialK test suites
$ sbt specialk/test
  ...

# Run the test suites for all projects
$ sbt test
  ...

# Build a Docker image
$ sbt gloseval/docker:publishLocal
  ...

NOTE: In order to run most tasks, MongoDB and RabbitMQ must also be running.

For the Agent Service test suites, Memcached must also be running.

Issues

We welcome reports of any issues on the issue tracker.

We are also using JIRA to track issues for this project and the rest of the Synereo Platform: https://synereo.atlassian.net/projects/SOC/issues