Configuration#

Gluu Gateway#

The Gluu Gateway service is used to manage all components, including: the Admin GUI Portal Konga, Kong, Postgres and the oxd Server.

Warning

Stopping one service may affect others. Make sure all required services are up and running to provide a stable Gluu Gateway environment.

Manage the Gluu Gateway service:

 # service gluu-gateway [start|stop|restart|status]

Admin GUI Portal - Konga#

Configure Konga by setting properties in the local.js file. This is used to set the port, oxd, OP and client settings.

 /opt/gluu-gateway/konga/config/local.js

Property	Description
kong_admin_url	Used to set Kong admin URL
connections	Used to set Postgres DB configuration for Admin GUI
models	Used to set the Database model
session	Session secret is automatically generated when your new app is created. It uses Connect's cookie parser to normalize configuration differences between Express and Socket.io and hooks into Sails' middleware interpreter to allow you to access and auto-save to `req.session` with Socket.io the same way you would with Express.
ssl	Used to set SSL certificates for the GUI Application. This enables application to use https
port	Used to set application port
environment	Used to set project environment. Konga and Gluu Gateway service start application with production environment.
log	Used to set the log level
oxdWeb	Used to set oxd Server URL
opHost	Used to set your OP server URL
oxdId	Used to set the oxd OP client oxd_id which is used for login in GG GUI
clientId	Used to set the OP Client's client id which is used for login in GG GUI
clientSecret	Used to set the OP Client's client secret which is used for login in GG GUI
oxdVersion	Used to set oxd server version
ggVersion	It shows the Gluu Gateway version
explicitHost	Used to define Gluu gateway GUI host explicitly. It by default listens to localhost only for security. You can set it with global IP to access GUI globally.

GUI is in sailsjs-v0.12 node js framework. For more detail configuration take a look on sailjs documentation.

Manage the Konga service

 # service konga [start|stop|restart|status]

Kong#

Configure Kong by using the kong.conf file.
```
 /etc/kong/kong.conf
```

Manage the Kong service

 # service kong [restart|stop|restart|status]

or

 # kong [restart|stop|restart|status]

oxd#

Refer to the oxd docs for more information on the topics below.

Configure the oxd Server
```
 /etc/oxd/oxd-server/oxd-conf.json
```

Manage the oxd Server service

 # service oxd-server [start|stop|restart|status]

Restore Kong to factory default#

Execute the following sequence of commands:

Stop Kong.
```
 # kong stop
```
The reset option is used to reset the configured database. It deletes all the tables and data of the configured database.
```
 # kong migrations reset
```
The up option is used to create a table in the configured database. It also executes all missing migrations up to the latest available one.
```
 # kong migrations up
```
Start Kong.
```
 # kong start
```

Migrate from Development to Production#

To migrate data from a development server to the production server, follow these steps. Depending on your setup, some steps may not be required.

Export kong and konga database from development server.

 $ pg_dump --dbname=postgresql://postgres:admin@localhost:5432/konga > konga.sql
 $ pg_dump --dbname=postgresql://postgres:admin@localhost:5432/konga > kong.sql

Install and set up GG on the production server.
Stop the oxd server on the production server.
Replace the oxd DB files, located in /opt/oxd-server/data/, in the production server with those in the development server .
Start oxd server with service oxd-server start.
Stop Kong and Konga with service kong stop and service konga stop.
Drop konga and kong databases on the production server.

 $ sudo -iu postgres /bin/bash -c 'psql -c "Drop database konga"'
 $ sudo -iu postgres /bin/bash -c 'psql -c "Drop database kong"'

Create two databases named konga and kong.

 $ sudo -iu postgres /bin/bash -c 'psql -c "Create database konga"'
 $ sudo -iu postgres /bin/bash -c 'psql -c "Create database kong"'

Import the above SQL file in production server.

 $ sudo -iu postgres /bin/bash -c "psql konga < absolute_path/konga.sql"
 $ sudo -iu postgres /bin/bash -c "psql kong < absolute_path/kong.sql"

Start the Kong and Konga services with service kong start and service konga stop.

If using a different Gluu Server in production than in development, you need to configure the plugin in production with the new client credentials.

Info

absolute_path is full path of your file. For example, if your file is in home folder, the path is /home/konga.sql.