Build development environment

Target OS

Windows

List of tools necessary for development

Download the necessary tools for development.

Tool name	Version	Download URL
Eclipse (Pleiades)	2018-09 Full Edition or later	http://mergedoc.osdn.jp/
AdoptOpenJDK	8 series / HotSpot	https://adoptopenjdk.net/
Git	Latest	https://git-scm.com/
Maven	3 series	https://maven.apache.org/download.cgi

List of tools necessary for operation check

Please download the necessary tools for operation check.

Tool name	Version	Download URL
Tomcat	9.0 series	Pleiades Do not introduce individual items to use the items included
Elasticsearch	6.6.1	https://www.elastic.co/jp/downloads/past-releases/elasticsearch-6-6-1
ActiveMQ	5.15 series	http://activemq.apache.org/download-archives.html
Nginx	1.14 series	http://nginx.org/download/nginx-1.14.0.zip

Initial setting of various tools

Eclipse

Add AdoptOpenJDK to the installed JRE from [Window]-> [Settings].
Set AddOpenOpenJDK as default.
Add a Tomcat 9 server to the server runtime environment from [Window]-> [Settings].
Set AdoptOpenJDK to JRE.

JDK

Set environment variable (JAVA_HOME).

variable:JAVA_HOME
value:java installation directory path(e.g.: C:\Program Files\Java\openjdk-1.8.0.191)

Add the following to the system environment variable (Path).

%JAVA_HOME%\bin

Git

Add the following description to C:¥Users¥[user]¥.gitconfig

[core]
    autocrlf = false
    ignorecase = false

When building a development environment under a proxy environment, we also add the following.
* The value of {} will input your own information.

[http]
    proxy = {protocol}://{username}:{pass}@{host}:{port}
[https]
    proxy = {protocol}://{username}:{pass}@{host}:{port}

Maven

Set environment variable (M2_HOME).

variable:M2_HOME
value:maven installation directory path(e.g.: C:\Program Files\apache-maven-3.5.4)

Add the following to the system environment variable (Path).

%M2_HOME%\bin

When building a development environment under a proxy environment, add the following description to apache-maven-3.5.4 \ conf \ settings.xml.
* The value of {} will input your own information.

<proxies>
  <proxy>
      <id>proxy00</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>{username}</username>
      <password>{pass}</password>
      <host>{host}</host>
      <port>{port}</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
  </proxy>
  <proxy>
      <id>proxy01</id>
      <active>true</active>
      <protocol>https</protocol>
      <username>{username}</username>
      <password>{pass}</password>
      <host>{host}</host>
      <port>{port}</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
  </proxy>
</proxies>

Elasticsearch

Modification of elasticsearch-6.6.1\config\elasticsearch.yml

Add the following description to elasticsearch.yml.

cluster.name: {Optional name}

network.host: 0.0.0.0
action.auto_create_index: ".watches,.triggered_watches,.watcher-history-*"
http.cors.enabled: true
http.cors.allow-origin: "*"
indices.fielddata.cache.size: 80%(Optional: What percent of heap memory is used as data cache)

ActiveMQ

none

Tomcat

none

Nginx

For initialization of Nginx, modify the nginx.conf file under nginx-1.14.0\conf.

Add a description below in http.

    ignore_invalid_headers on;
    proxy_set_header Host $http_host;
    proxy_http_version 1.1;
    large_client_header_buffers 4 55k;

    map $http_upgrade $connection_upgrade {
      default upgrade;
      '' close;
    }

Change contents of http.server.location / to the following description.

            #root   html;
            #index  index.html index.htm;

            if ($request_uri ~ [\x00-\x20\x22\x3c\x3e\x5b-\x5e\x60\x7b-\x7d\x7f]) {
                return 400;
            }

            if ($request_uri ~* ([^?]+)\?(.*)) {
              set $personium_path $1;
              rewrite .* /personium-core$personium_path break;
            }
            if ($is_args = "") {
              rewrite .* /personium-core$request_uri break;
            }

            proxy_pass http://localhost:8080;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_set_header X-Forwarded-Proto http;
            proxy_set_header X-Forwarded-Path $request_uri;
            proxy_set_header Host $http_host;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection $connection_upgrade;
            proxy_hide_header X-Powered-By;
            proxy_hide_header X-Rack-Cache;
            proxy_hide_header X-Content-Digest;
            proxy_hide_header X-Runtime;

Project import in Eclipse

Import personium-core and personium-engine as a project.

Clone from the GitHub repository.
https://github.com/personium/personium-core.git
https://github.com/personium/personium-engine.git
Import each as an Eclipse maven project.
Create personium-unit-config.properties in each /src/main/resources.

The value of io.personium.core.es.cluster.name is the Elasticsearch config file (elasticsearch.yml)
Specify the value set in cluster.name of the cluster.

/personium_core/src/main/resources/personium-unit-config.properties

#################################################
# personium-core configurations
#################################################
# general configurations
io.personium.core.masterToken=personiumio
io.personium.core.unitScheme=http
#io.personium.core.unitPort=9998
#io.personium.core.unitPort=8080
io.personium.core.unitPort=
#io.personium.core.unitPath=/personium-core
io.personium.core.unitPath=
io.personium.core.pathBasedCellUrl.enabled=true

io.personium.core.unitUser.issuers=personium-localunit:/unitadmin/ personium-localunit:/unitadmincell/ personium-localunit:/unitusercell/

# cell configurations
io.personium.core.cell.relayhtmlurl.default=https://app-cc-home.demo.personium.io/__/index.html

io.personium.core.es.cluster.name={Value set with elasticsearch.yml}
io.personium.core.es.retryTimes=10

io.personium.core.plugin.path=/personium/plugins
io.personium.core.blobStore.root=/personium_nfs/personium-core/dav
io.personium.core.bar.tmp.dir=/personium_nfs/personium-core/bar
io.personium.core.event.log.current.dir=/personium_nfs/personium-core/eventlog
io.personium.core.cellSnapshot.root=/personium_nfs/personium-core/snapshot

# lock type configurations
io.personium.core.lock.type=inProcess

# cache configurations (memcached protocol)
io.personium.core.cache.type=inProcess
io.personium.core.cache.cell.enabled=false
io.personium.core.cache.box.enabled=false
io.personium.core.cache.schema.enabled=false

# security configurations
io.personium.core.security.secret16=gv7hpmmf5siwj5by
io.personium.core.security.auth.password.salt=voAbizvF
io.personium.core.security.dav.encrypt.enabled=false

# Davlimit configurations
io.personium.core.dav.childresource.maxnum=30
io.personium.core.dav.depth.maxnum=5

# OData $links configurations
io.personium.core.odata.links.NtoN.maxnum=40

/personium_engine/src/main/resources/personium-unit-config.properties

#################################################
# personium-engine configurations
#################################################
# general configurations
io.personium.core.masterToken=personiumio

io.personium.core.blobStore.root=/personium_nfs/personium-core/dav

# security configurations
io.personium.core.security.secret16=secret167pm5m4y6

* For the explanation of each setting, please refer to Unit configurations.

* If there are maven and pom.xml related build errors on Eclipse,
Please carry out the procedure described below.

Move to the directory where pom.xml exists at the command prompt etc.
Execute the following command.
```
mvn clean package -DskipTests
```
If the command does not end with SUCCESS, remove the cause and re-execute.
In Eclipse, right-click the target project -> [Maven] -> [Update Project] -> [OK].

Startup confirmation method

Execute the command as a user with administrator authority.

1. Elasticsearch launch confirmation

Go to Elasticsearch installation directory at the command prompt etc.

> cd Elasticsearch installation directory

Execute the following command.

> bin\elasticsearch-service install (First time only)
> bin\elasticsearch-service start

Access http://localhost:9200 in the browser.

The output will be successful if it is output as follows.

{
  "name" : "MODAM",
  "cluster_name" : "{Value set with elasticsearch.yml}",
  "cluster_uuid" : "VM2fJ2hXQRSI4PsYhJBtLA",
  "version" : {
    "number" : "6.6.1",
    "build_flavor" : "default",
    "build_type" : "zip",
    "build_hash" : "1fd8f69",
    "build_date" : "2019-02-13T17:10:04.160291Z",
    "build_snapshot" : false,
    "lucene_version" : "7.6.0",
    "minimum_wire_compatibility_version" : "5.6.0",
    "minimum_index_compatibility_version" : "5.0.0"
  },
  "tagline" : "You Know, for Search"
}

2. ActiveMQ startup confirmation

Go to the Activemq installation directory with command prompt etc.

> cd Activemq installation directory

Execute the following command.

> bin\activemq start

Access http://localhost:8161 in the browser.
The startup will be successful when the management screen is displayed.

By running the below, you can make it into a windows service.

> bin\win64\InstallService.bat

Reference: https://activemq.apache.org/java-service-wrapper,

3. Startup confirmation for development server

In Eclipse, right-click the [personium-core] project -> select [Run] -> [Run on Server].

The server selects and runs the Tomcat9 server added by default.

* Starting Tomcat 9 may cause a startup error to exceed the timeout time.
Please change the timeout time at Tomcat startup in Eclipse.

Access http://localhost:8080/personium-core/ in the browser.
The output will be successful if it is output as follows.

{"unit":{"path_based_cellurl_enabled":true,"url":"http:\/\/localhost\/"}}

4. Confirm Nginx startup

Navigate to the Nginx installation directory with a command prompt.

> cd Nginx installation directory

Execute the following command.

> start nginx

Access http://localhost in the browser.
The output will be successful if it is output as follows.

{"unit":{"path_based_cellurl_enabled":true,"url":"http:\/\/localhost\/"}}

Personium

1.7.21

Prepare Personium

Develop App

For Server Operator

For Unit Administrator

Old Docs

Authorization

Box/Bar File

Collection

Old Docs

For Document Contribution

For Code Contribution

Build development environment

Target OS

List of tools necessary for development

List of tools necessary for operation check

Initial setting of various tools

Eclipse

JDK

Git

Maven

Elasticsearch

Modification of elasticsearch-6.6.1\config\elasticsearch.yml

ActiveMQ

Tomcat

Nginx

Project import in Eclipse

Startup confirmation method

1. Elasticsearch launch confirmation

2. ActiveMQ startup confirmation

3. Startup confirmation for development server

4. Confirm Nginx startup