Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
public:start [2017-04-05 15:55:50] rihooks |
public:start [2023-09-17 09:38:58] (current) rihohiiepuu [Getting started] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Getting started on ROKSNET ====== | + | ====== Getting started (**Deprecated**) ====== |
- Install **Security Server** and setup **Trust Services**: | - Install **Security Server** and setup **Trust Services**: | ||
Line 9: | Line 9: | ||
**Tips:** | **Tips:** | ||
- | * You can use ready **RoksNet Portal** software for end-users (employees, customers, citizens etc.) | + | * You can install **RoksNet Portal** for your end-users (employees, customers, citizens etc.) |
- | * Use RoksNet Portal for own services **testing purposes** | + | * You can use **RoksNet Portal** for your own service testing purposes |
{{:public:docs:roksnet:simple.png?900|}} | {{:public:docs:roksnet:simple.png?900|}} | ||
+ | |||
+ | |||
+ | ---- | ||
Line 22: | Line 25: | ||
{{ :public:x-road_architecture.png?direct&800 |}} | {{ :public:x-road_architecture.png?direct&800 |}} | ||
- | ===== Important (to get a unique Member/User Code for RoksNet) ====== | + | ===== Important (to get a unique Member/User Code for RoksNet Development environment) ====== |
Before setting up your Security Server, please provide the following information to us: | Before setting up your Security Server, please provide the following information to us: | ||
Line 44: | Line 47: | ||
| Ubuntu 14.04 LTS x86-64 | Operating system | | | Ubuntu 14.04 LTS x86-64 | Operating system | | ||
| 2 GB RAM, 10 GB disk space | Minimum system requirements | | | 2 GB RAM, 10 GB disk space | Minimum system requirements | | ||
- | | http://apt.roksnet.com/xroad6-debs | RoksNet package repository | | + | | http://x-road.eu/packages | X-Road package repository | |
- | | http://apt.roksnet.com/xroad6-debs/roksnet_repo.gpg | The repository key | | + | | http://x-road.eu/packages/xroad_repo.gpg | The repository key | |
| TCP 5500 | Port inbound & outbound for message exchange between security servers | | | TCP 5500 | Port inbound & outbound for message exchange between security servers | | ||
| TCP 5577 | Port inbound & outbound for querying OCSP responses between security servers | | | TCP 5577 | Port inbound & outbound for querying OCSP responses between security servers | | ||
Line 78: | Line 81: | ||
INSTALLATION | INSTALLATION | ||
- | 3. Add the address of the RoksNet package repository and the nginx repository to to /etc/apt/sources.list.d/roksnet.list: | + | 3. Add the address of the X-Road package repository and the nginx repository to to /etc/apt/sources.list.d/xroad.list: |
- | <code>deb [arch=amd64] http://apt.roksnet.com/xroad6-debs trusty main | + | <code>deb http://x-road.eu/packages trusty main |
deb http://ppa.launchpad.net/nginx/stable/ubuntu trusty main | deb http://ppa.launchpad.net/nginx/stable/ubuntu trusty main | ||
deb http://ppa.launchpad.net/openjdk-r/ppa/ubuntu trusty main</code> | deb http://ppa.launchpad.net/openjdk-r/ppa/ubuntu trusty main</code> | ||
- | 4. Add RoksNet's repository's signing key to the list of trusted keys: | + | 4. Add X-Road's repository's signing key to the list of trusted keys: |
- | <code>curl http://apt.roksnet.com/xroad6-debs/roksnet_repo.gpg | sudo apt-key add -</code> | + | <code>curl http://x-road.eu/packages/xroad_repo.gpg | sudo apt-key add -</code> |
<code>sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 00A6F0A3C300EE8C</code> | <code>sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 00A6F0A3C300EE8C</code> | ||
<code>sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys EB9B1D8886F44E2A</code> | <code>sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys EB9B1D8886F44E2A</code> | ||
Line 90: | Line 93: | ||
5. Install the security server software: | 5. Install the security server software: | ||
<code>sudo apt-get update</code> | <code>sudo apt-get update</code> | ||
+ | <code>sudo apt-get install openjdk-8-jre-headless</code> | ||
<code>sudo apt-get install xroad-securityserver</code> | <code>sudo apt-get install xroad-securityserver</code> | ||
Line 240: | Line 244: | ||
6. Install postgreSQL | 6. Install postgreSQL | ||
+ | For ubuntu 16.04 LTS | ||
+ | <code bash> | ||
+ | vi /etc/apt/sources.list.d/pgdg.list | ||
+ | </code> | ||
+ | add line: | ||
+ | <code bash> | ||
+ | deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main | ||
+ | </code> | ||
+ | Add key | ||
+ | <code bash> | ||
+ | wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add - | ||
+ | </code> | ||
+ | |||
+ | <code bash> | ||
+ | apt-get update | ||
+ | apt-get install postgresql-9.3 | ||
+ | </code> | ||
+ | |||
+ | For ubuntu 14.04 LTS | ||
<code>apt-get install postgresql-9.3</code> | <code>apt-get install postgresql-9.3</code> | ||
Line 384: | Line 407: | ||
=== Python example === | === Python example === | ||
- | Source code of example: {{ :public:docs:roksnet:pyxadapter_1.3.tgz |}} | + | Source code of example: [[https://github.com/Roksnet/Python-adapter-example|https://github.com/Roksnet/Python-adapter-example]] |
- | + | The example contains library and two examples. Installation instructions are in included in the package. | |
- | The demo application is written in Python. Installation instructions are in included in the package (see INSTALL.txt) | + | |
- | + | ||
- | The example SOAP server accepts input messages in both X-road protocol 3.1 and 4.0 and formats response message according | + | |
- | to the same protocol which was used by the client. | + | |
- | The application contains source code of Population Registry, Passport database, Vehicle database, Company database and Prescription database demo services which are available in RoksNet Development Environment. | + | |
- | + | ||
- | To create a new SOAP server for Content Service provider: | + | |
- | * create SOAP server instance for SOAP server (example: pyxadapter/companydb_server/__init__.py) | + | |
- | * include service registration function and define routing for new SOAP server in pyxadapter/__init__.py | + | |
To create a new service in the SOAP server: | To create a new service in the SOAP server: | ||
- | * create service implementation function serve() (example: pyxadapter/companydb_server/simplequery.py) | + | * create service implementation function (example: example_hello/hello/services/helloservice.py) |
- | * import and registrate service implementation module (example: pyxadapter/companydb_server/__init__.py) | + | * import and register service implementation module (example: example_hello/hello/server.py) |
- | * create service description WSDL (example: pyxadapter/static/companydb_v4.wsdl) | + | * create service description WSDL (example: example_hello/hello/static/hello.wsdl) |
* publish service in Security Server and grant access to clients | * publish service in Security Server and grant access to clients | ||
To create SOAP client: | To create SOAP client: | ||
- | * create X-road client class (corresponding to a service provider) with methods corresponding to services and start calling those methods (example: pyxadapter/client/companydb.py) | + | * create X-road client class (corresponding to a service provider) with methods corresponding to services and start calling those methods (example: example_hello/hello/client.py) |
=== Java adapter example === | === Java adapter example === | ||
- | GitHub link: [[https://github.com/petkivim/x-road-adapter-example]] | + | GitHub link: [[https://github.com/vrk-kpa/xrd4j]] |
All of the related documentation is on the GitHub page | All of the related documentation is on the GitHub page | ||
+ | |||
+ | Since the example is not created by Roksnet, we do not guarantee the operation of the example with the Roksnet Portal. | ||
=== C# example with X-tee.NET === | === C# example with X-tee.NET === | ||
Line 547: | Line 563: | ||
* message-path-format - message log filename format | * message-path-format - message log filename format | ||
* temporaryStoragePath - optional path for saving attachments (if not provided, storagePath will be used). If value is :inmemory: then attachments will be handled in memory only | * temporaryStoragePath - optional path for saving attachments (if not provided, storagePath will be used). If value is :inmemory: then attachments will be handled in memory only | ||
+ | |||
+ | |||
+ | Since the example is not created by Roksnet, we do not guarantee the operation of the example with the Roksnet Portal. | ||