The Kinguard Project Wiki - User contributions [en]

Downloads

2020-08-08T08:40:51Z

Tor:

== Current release ==
The current release for The Kinguard Project is "Kinguard 20.07".

=== Install images ===
Install images are provided on the Kinguard [https://www.kinguardproject.org/download/releases/20.07 Download Area] for both OPI and KEEP.

Please read the [https://www.kinguardproject.org/download/releases/20.07/ReleaseNotes_20.07.pdf ReleseNotes].
=== How to install ===
For KEEP write the img-file to a USB stick and press and hold the button for 10 seconds while inserting power.

A simple cross platform tool to write .img files to an SD Card or USB Stick is Etcher. https://etcher.io/

'''For KEEP''', the installation takes about 3 minutes. Unfortunately there is currently no visual indication that the installation has completed. A hint though is that when the harddrive spins down, the installation is complete. After the completed installation the unit needs to be power cycled.

'''For OPI''' write the image file (.img) to a uSD card (using Etcher or similar tool), insert it into OPI and apply power.
OPI will turn off all LEDs when the installation is complete. When the installation is complete replace the installation SD-card with a blank SD card.

'''Special OPI note when upgradeing''' from the older OPI software to the newer Kinguard-based version. '''It is not possible to reuse data directly from an old SD-card'''. The default procedure is to perform a backup to USB and then do a complete reinstall with a new/newly formatted SD card.

If data is to be restored from a backup, the recommended way is to make sure that a backup on USB exists (usually faster than downloading from on-line servers), make a clean shutdown of OPI and then leave the USB memory inserted during the setup. The data set can then be chosen during the "Restore" step of the setup procedure.

=== Installer Configuration ===
In the installer image there is a configuration file that can be used to alter the behavior of the installer image.

In "/etc/kgp-install.conf" there are few parameters available. Note that you need to be "root" in order to change these parameters.

DO_INSTALL=1

By default this parameter is set to "1", which will cause the image to basically do a factory reset by formatting the internal eMMC and reinstalling system software. Any data on the data disk will be left intact.

If set to '0', the system will boot into a rescue mode, leaving all data on the system intact, but allowing access to the system using ssh and serial console.

DO_ADDROOT=0

By default this parameter is set to "0". By changing this to "1", the system will be installed a root account is added with the password "op237".
This is only available on the serial port, ssh is not enabled by default.

How to connect to the serial port is described [[Enable serial console|here]].

== Older releases provided by OpenProducts ==

=== OPI ===

[https://www.kinguardproject.org/download/releases/OpenProducts-OPI-Legacy/install/ Installation images]

[https://www.kinguardproject.org/download/releases/OpenProducts-OPI-Legacy/rescue/ Rescue images]

Instructions on how to reinstall is available [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=466 here]

The rescue image is very similar to the install image, only that the image does not re-install the system. The system will be available both on the serial port and on ssh with the user/password of root/op237. The root file system can then be accessed and manipulated, but all user data is only available if the encrypted partition in unlocked and mounted by hand.

=== KEEP ===

[https://www.kinguardproject.org/download/releases/OpenProducts-KEEP-Legacy Installation images]

Downloads

2019-06-05T12:02:03Z

Tor:

== Current release ==
The current release for The Kinguard Project is "Kinguard 19.06".

=== Install images ===
Install images are provided on the Kinguard [https://www.kinguardproject.org/download/releases/19.06/ Download Area] for both OPI and KEEP.

Please read the [https://www.kinguardproject.org/download/releases/19.06/ReleaseNotes_19.06.pdf ReleseNotes].
=== How to install ===
For KEEP write the img-file to a USB stick and press and hold the button for 10 seconds while inserting power.

A simple cross platform tool to write .img files to an SD Card or USB Stick is Etcher. https://etcher.io/

'''For KEEP''', the installation takes about 3 minutes. Unfortunately there is currently no visual indication that the installation has completed. A hint though is that when the harddrive spins down, the installation is complete. After the completed installation the unit needs to be power cycled.

'''For OPI''' write the image file (.img) to a uSD card (using Etcher or similar tool), insert it into OPI and apply power.
OPI will turn off all LEDs when the installation is complete. When the installation is complete replace the installation SD-card with a blank SD card.

'''Special OPI note when upgradeing''' from the older OPI software to the newer Kinguard-based version. '''It is not possible to reuse data directly from an old SD-card'''. The default procedure is to perform a backup to USB and then do a complete reinstall with a new/newly formatted SD card.

If data is to be restored from a backup, the recommended way is to make sure that a backup on USB exists (usually faster than downloading from on-line servers), make a clean shutdown of OPI and then leave the USB memory inserted during the setup. The data set can then be chosen during the "Restore" step of the setup procedure.

=== Installer Configuration ===
In the installer image there is a configuration file that can be used to alter the behavior of the installer image.

In "/etc/kgp-install.conf" there are few parameters available. Note that you need to be "root" in order to change these parameters.

DO_INSTALL=1

By default this parameter is set to "1", which will cause the image to basically do a factory reset by formatting the internal eMMC and reinstalling system software. Any data on the data disk will be left intact.

If set to '0', the system will boot into a rescue mode, leaving all data on the system intact, but allowing access to the system using ssh and serial console.

DO_ADDROOT=0

By default this parameter is set to "0". By changing this to "1", the system will be installed a root account is added with the password "op237".
This is only available on the serial port, ssh is not enabled by default.

How to connect to the serial port is described [[Enable serial console|here]].

== Older releases provided by OpenProducts ==

=== OPI ===

[https://www.kinguardproject.org/download/releases/OpenProducts-OPI-Legacy/install/ Installation images]

[https://www.kinguardproject.org/download/releases/OpenProducts-OPI-Legacy/rescue/ Rescue images]

Instructions on how to reinstall is available [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=466 here]

The rescue image is very similar to the install image, only that the image does not re-install the system. The system will be available both on the serial port and on ssh with the user/password of root/op237. The root file system can then be accessed and manipulated, but all user data is only available if the encrypted partition in unlocked and mounted by hand.

=== KEEP ===

[https://www.kinguardproject.org/download/releases/OpenProducts-KEEP-Legacy Installation images]

OPIForceReinstall

2018-12-22T16:03:38Z

Tor: /* Reinstall */

== Howto reinstall a dead OPI ==

This howto covers howto recover a bricked dead OPI or a forced downgrade from a newer version to an older one. For a normal reinstall se here [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=466 (Re)Installing OPI]

In some rare occasions OPI could end up in a "dead" unrecoverable state. This could for example be the result of an interrupted reinstall or a filesystem corrupted in another way. In this situation the normal startup never finishes and a normal reinstall is never started.

== Prerequisites ==

To perform the re-installation you will have to remove the cover of OPI thus you need the following

* Complete OPI with network and power supply/USB-cable.
* Torx T10 screwdriver
* SD card with installer (Read [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=466 (Re)Installing OPI] on how to create.

== Disassemble OPI ==

Turn OPI upside down and locate the four screws. Note that the upper left screw is located under the sticker.

[[File:OPI-Bottom.png|none|thumb|OPI bottom]]
Use the screw driver to remove the four screws and then gently remove the upper cover.
[[File:OPI-uncovered.jpg|thumb|none|OPI without cover]]

== Reinstall ==

Locate the top left button on OPI

[[File:OPI-buttons-marked.jpg|thumb|none|Alternate boot button]]

Insert the install SD-card into OPI and hold down the button while inserting the power cable. When led is lit you can release the button.
[[File:OPI-power-on.jpg|thumb|none|OPI power on]]
Now wait for the installation to complete as described in the (RE)installing OPI.

OPIForceReinstall

2018-12-22T16:02:59Z

Tor:

== Howto reinstall a dead OPI ==

This howto covers howto recover a bricked dead OPI or a forced downgrade from a newer version to an older one. For a normal reinstall se here [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=466 (Re)Installing OPI]

In some rare occasions OPI could end up in a "dead" unrecoverable state. This could for example be the result of an interrupted reinstall or a filesystem corrupted in another way. In this situation the normal startup never finishes and a normal reinstall is never started.

== Prerequisites ==

To perform the re-installation you will have to remove the cover of OPI thus you need the following

* Complete OPI with network and power supply/USB-cable.
* Torx T10 screwdriver
* SD card with installer (Read [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=466 (Re)Installing OPI] on how to create.

== Disassemble OPI ==

Turn OPI upside down and locate the four screws. Note that the upper left screw is located under the sticker.

[[File:OPI-Bottom.png|none|thumb|OPI bottom]]
Use the screw driver to remove the four screws and then gently remove the upper cover.
[[File:OPI-uncovered.jpg|thumb|none|OPI without cover]]

== Reinstall ==

Locate the top left button on OPI

[[File:OPI-buttons-marked.jpg|thumb|none|Alternate boot button]]

Insert the install SD-card into OPI and hold down the button while inserting the power cable. When led is lit you can de-press the button.
[[File:OPI-power-on.jpg|thumb|none|OPI power on]]
Now wait for the installation to complete as described in the (RE)installing OPI.

OPIForceReinstall

2018-12-22T15:59:56Z

Tor:

== Howto reinstall a dead OPI ==

This howto covers howto recover a bricked dead OPI or a forced downgrade from a newer version to an older one. For a normal reinstall se here [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=466 (Re)Installing OPI]

In some rare occasions OPI could end up in a "dead" unrecoverable state. This could for example be the result of an interrupted reinstall or a filesystem corrupted in another way. In this situation the normal startup never finishes and a normal reinstall is never started.

== Prerequisites ==

To perform the re-installation you will have to remove the cover of OPI thus you need the following

* Complete OPI with network and power supply/USB-cable.
* Torx T9 screwdriver
* SD card with installer (Read [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=466 (Re)Installing OPI] on how to create.

== Disassemble OPI ==

Turn OPI upside down and locate the four screws. Note that the upper left screw is located under the sticker.

[[File:OPI-Bottom.png|none|thumb|OPI bottom]]
Use the screw driver to remove the four screws and then gently remove the upper cover.
[[File:OPI-uncovered.jpg|thumb|none|OPI without cover]]

== Reinstall ==

Locate the top left button on OPI

[[File:OPI-buttons-marked.jpg|thumb|none|Alternate boot button]]

Insert the install SD-card into OPI and hold down the button while inserting the power cable. When led is lit you can de-press the button.
[[File:OPI-power-on.jpg|thumb|none|OPI power on]]
Now wait for the installation to complete as described in the (RE)installing OPI.

File:OPI-power-on.jpg

2018-12-22T15:59:09Z

Tor:

OPI power on with alternate boot

File:OPI-buttons-marked.jpg

2018-12-22T15:48:05Z

Tor:

OPI with boot button marked

File:OPI-uncovered.jpg

2018-12-22T15:41:50Z

Tor:

OPI with cover removed

File:OPI-Bottom.png

2018-12-22T15:32:52Z

Tor:

OPI bottom up with screws marked.

OPIForceReinstall

2018-12-22T11:47:45Z

Tor: Created page with "== Howto reinstall a dead OPI == '''Work in progress!''' This howto covers howto recover a bricked dead OPI or a forced downgrade from a newer version to an older one. For a..."

== Howto reinstall a dead OPI ==

'''Work in progress!'''

This howto covers howto recover a bricked dead OPI or a forced downgrade from a newer version to an older one. For a normal reinstall se here [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=466 (Re)Installing OPI]

In some rare occasions OPI could end up in a "dead" unrecoverable state. This could for example be the result of an interrupted reinstall or a filesystem corrupted in another way. In this situation the normal startup never finishes and a normal reinstall is never started.

Tutorials and How-tos

2018-12-22T11:40:14Z

Tor: /* Intermediate */

== Beginner ==

* [[Access your unit using SSH]]
* [[SSH access using private/public key pair]]
* [[Run a backup manually]]
* [[DavDroid Crashes when adding a nextcloud account]]

== Intermediate ==
* [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=750/ Change to a larger SD card on OPI]
* [[Enable serial console]]
* [[OPIForceReinstall|Reinstall dead OPI]]

Downloads

2018-10-15T13:20:17Z

Tor: Fixed typo and added section on OPI dist upgrade

== Current release ==
The current release for The Kinguard Project is "Kinguard 18.06".

=== Install images ===
Install images are provided on the Kinguard [https://www.kinguardproject.org/download/releases/18.06/ Download Area] for both OPI and KEEP.

Please read the [https://www.kinguardproject.org/download/releases/18.06/ReleaseNotes_18.06.pdf ReleseNotes].
=== How to install ===
For KEEP write the img-file to a USB stick and press and hold the button for 10 seconds while inserting power.

A simple cross platform tool to write .img files to an SD Card or USB Stick is Etcher. https://etcher.io/

For KEEP, the installation takes about 3 minutes. Unfortunately there is currently no visual indication that the installation has completed. A hint though is that when the harddrive spins down, the installation is complete. After the completed installation the unit needs to be power cycled.

For OPI write the image to a uSD card, insert it into OPI and apply power.
OPI will turn off all LEDs when the installation is complete.

'''Special OPI note''' regarding upgrading from the older OPI software to the newer Kinguard-based version. It is currently not possible to reuse data directly from an old SD-card. The default procedure is to perform a backup to USB and then do a complete reinstall with a new/newly formatted SD card.

If data is to be restored from a backup, the recommended way is to make sure that a backup on USB exists (usually faster than downloading from on-line servers), make a clean shutdown of OPI and then leave the USB memory inserted during the setup. The data set can then be chosen during the "Restore" step of the setup procedure.

=== Installer Configuration ===
In the installer image there is a configuration file that can be used to alter the behavior of the installer image.

In "/etc/kgp-install.conf" there are few parameters available. Note that you need to be "root" in order to change these parameters.

DO_INSTALL=1

By default this parameter is set to "1", which will cause the image to basically do a factory reset by formatting the internal eMMC and reinstalling system software. Any data on the data disk will be left intact.

If set to '0', the system will boot into a rescue mode, leaving all data on the system intact, but allowing access to the system using ssh and serial console.

DO_ADDROOT=0

By default this parameter is set to "0". By changing this to "1", the system will be installed a root account is added with the password "op237".
This is only available on the serial port, ssh is not enabled by default.

How to connect to the serial port is described [[Enable serial console|here]].

== Older releases provided by OpenProducts ==

=== OPI ===

[https://download.openproducts.com/opi/install/ Installation images]

[https://download.openproducts.com/opi/rescue/ Rescue images]

Instructions on how to reinstall is available [https://www.kinguardproject.org/forum/viewtopic.php?f=345&t=466 here]

The rescue image is very similar to the install image, only that the image does not re-install the system. The system will be available both on the serial port and on ssh with the user/password of root/op237. The root file system can then be accessed and manipulated, but all user data is only available if the encrypted partition in unlocked and mounted by hand.

=== KEEP ===

[https://download.openproducts.com/keep/install/ Installation images]

Documentation/sysconfig

2018-07-06T08:31:52Z

Tor: /* Config scopes and variables */

=System configuration file=

The kinguard system components store all generic none security sensitive configuration in a central configuration file "/etc/kinguard/sysconfig.json".

This file should however never be manually edited it should always be accessed programatically using either [https://github.com/Kinguard/libkgp libkgp] or any wrapper to this library described further down.

=== File Syntax ===
For reference here is the layout of the sysconfig json file. Please read the file for reference but never ever edit it manually.

The complete configuration file is one json object (note that javascript object syntax is not permitted).

The file is set up using a "scope" and "key/value" pairs.

All scope and key identifiers shall be lowercase and written with '''letters and digits only''', no "-" or "_".

Example:
{
"webapps":
{
"theme":"kgp"
},
"hostinfo":
{
"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939",
"hostname":"myhost",
"domain":"example.org"
}
}

=== Native access via libkgp ===
Libkgp is the main library to use when programming locally for the kinguard system it contains c++ objects for managing all kinguard functions. No official documentation exists for this yet but pointers on how it works can be found in the [https://github.com/Kinguard/libkgp/tree/master/test unit tests] and in the applications utilizing them for example [https://github.com/Kinguard/kgp-backend KGP backend] and [https://github.com/Kinguard/kgp-control KGP startup control]

To access the system configuration the [https://github.com/Kinguard/libkgp/blob/master/SysConfig.h SysConfig class]

=== Wrappers ===
Most wrappers can also be used to access other information provided by libkgp, such as the current running system type, information about system storage etc.

===== Shell Scripts =====
For shell scripts, use "[https://github.com/Kinguard/kinguard-utils kgp-sysinfo]". Run kgp-sysinfo --help for options.

Example:
# kgp-sysinfo -c hostinfo -k unitid -p
c79f425c-9af7-4f38-b1ba-d53277b14939

# kgp-sysinfo -c hostinfo -k unitid
{"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939"}

===== Python =====
For Python3, use the python library "[https://github.com/Kinguard/kgp-pywrap pylibopi]"

Example:
>>> import pylibopi
>>> pylibopi.StorageDevice()
'/dev/disk/by-path/platform-f10a8000.sata-ata-2'

===== C =====
For C programs, [https://github.com/Kinguard/libkgp_wrapper libkgp_wrapper] can be used.

===== PHP =====
Currently no native PHP wrapper exists, but kgp-sysinfo defaults to output json (see above) that can easily be used in PHP.

= Config scopes and variables =
Very few of these parameters are mandatory. However default behavior for the applications will vary if an expected parameter is missing.

- autoupdate
|- enabled turns on and off automatic updates

- backup
|- backend which storage backend to use for s3ql
|- devicemountpath where to mount local devices, such as usb memories
|- enabled turns on and off the backup service

- dns
|- dnsauthkey path to the private key used for lower level authentication on service provider backends
|- dnspubkey path to corresponding public key
|- enabled turns on and off dns updates
|- provider backend provider

- filesystem
|- storagemount mountpoint of storage volume
|- luksdevice luks-created cryptodevice (If used)
|- lvmdevice lvm-created storage pool (If used)
|- lvmvg lvm-created volume group (If used)
|- lvmlv lvm-created logical volume (If used)

- hostinfo
|- unitid system id to use as account identifier for service provider backends
|- hostname the 'host' part of the [https://en.wikipedia.org/wiki/Fully_qualified_domain_name FQDN]
|- domain the 'domain' part of the FQDN
|- cafile the ca file used to verify service provider backends
|- sysauthkey the key used to access data on service provider backends
|- syspubkey corresponding public key

- mail
|- localmail configuration file for local mail delivery, relative to filesystem->storagemount
|- virtualalias configuration file for virtual mail aliases, relative to filesystem->storagemount
|- vmailbox path to virtual mailbox mapping, relative to filesystem->storagemount
|- vdomains path to virtual domains file (Which domains to accept mail from), relative to filesystem->storagemount
|- saslpasswd path to sasl password store file, relative to filesystem->storagemount
|- oprelayserver URL to OpenProducts smtp-relay

- setup
|- conntesthost host used for connectivity tests

- upnp
|- forwardports which ports the device shall try to forward from a UPNP gateway

- webapps
|- theme the theme used by webapps

- webcertificate
|- backend backend provider
|- enabled turns on and off generation of web certificates
|- certpath the location where signed certificate are stored
|- customcert full path to custom certificate
|- customkey full path to private key for the custom certificate
|- activecert path to symlink for the certificate being used
|- activekey path to symlink for key corresponding to activecert

Documentation/sysconfig

2018-07-05T13:27:55Z

Tor: /* Config scopes and variables */

Documentation/sysconfig

2018-07-05T12:45:57Z

Tor: /* Config scopes and variables */

=System configuration file=

The kinguard system components store all generic none security sensitive configuration in a central configuration file "/etc/kinguard/sysconfig.json".

This file should however never be manually edited it should always be accessed programatically using either [https://github.com/Kinguard/libkgp libkgp] or any wrapper to this library described further down.

=== File Syntax ===
For reference here is the layout of the sysconfig json file. Please read the file for reference but never ever edit it manually.

The complete configuration file is one json object (note that javascript object syntax is not permitted).

The file is set up using a "scope" and "key/value" pairs.

All scope and key identifiers shall be lowercase and written with '''letters and digits only''', no "-" or "_".

Example:
{
"webapps":
{
"theme":"kgp"
},
"hostinfo":
{
"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939",
"hostname":"myhost",
"domain":"example.org"
}
}

=== Native access via libkgp ===
Libkgp is the main library to use when programming locally for the kinguard system it contains c++ objects for managing all kinguard functions. No official documentation exists for this yet but pointers on how it works can be found in the [https://github.com/Kinguard/libkgp/tree/master/test unit tests] and in the applications utilizing them for example [https://github.com/Kinguard/kgp-backend KGP backend] and [https://github.com/Kinguard/kgp-control KGP startup control]

To access the system configuration the [https://github.com/Kinguard/libkgp/blob/master/SysConfig.h SysConfig class]

=== Wrappers ===
Most wrappers can also be used to access other information provided by libkgp, such as the current running system type, information about system storage etc.

===== Shell Scripts =====
For shell scripts, use "[https://github.com/Kinguard/kinguard-utils kgp-sysinfo]". Run kgp-sysinfo --help for options.

Example:
# kgp-sysinfo -c hostinfo -k unitid -p
c79f425c-9af7-4f38-b1ba-d53277b14939

# kgp-sysinfo -c hostinfo -k unitid
{"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939"}

===== Python =====
For Python3, use the python library "[https://github.com/Kinguard/kgp-pywrap pylibopi]"

Example:
>>> import pylibopi
>>> pylibopi.StorageDevice()
'/dev/disk/by-path/platform-f10a8000.sata-ata-2'

===== C =====
For C programs, [https://github.com/Kinguard/libkgp_wrapper libkgp_wrapper] can be used.

===== PHP =====
Currently no native PHP wrapper exists, but kgp-sysinfo defaults to output json (see above) that can easily be used in PHP.

= Config scopes and variables =
Very few of these parameters are mandatory. However default behavior for the applications will vary if an expected parameter is missing.

- autoupdate
|- enabled turns on and off automatic updates

- backup
|- backend which storage backend to use for s3ql
|- devicemountpath where to mount local devices, such as usb memories
|- enabled turns on and off the backup service

- dns
|- dnsauthkey path to the private key used for lower level authentication on service provider backends
|- dnspubkey path to corresponding public key
|- enabled turns on and off dns updates
|- provider backend provider

- filesystem
|- storagemount mountpoint of storage volume
|- luksdevice luks-created cryptodevice (If used)
|- lvmdevice lvm-created storage pool (If used)
|- lvmvg lvm-created volume group (If used)
|- lvmlv lvm-created logical volume (If used)

- hostinfo
|- unitid system id to use as account identifier for service provider backends
|- hostname the 'host' part of the [https://en.wikipedia.org/wiki/Fully_qualified_domain_name FQDN]
|- domain the 'domain' part of the FQDN
|- cafile the ca file used to verify service provider backends
|- sysauthkey the key used to access data on service provider backends
|- syspubkey corresponding public key

- mail
|- localmail configuration file for local mail delivery, relative to filesystem->storagemount
|- virtualalias configuration file for virtual mail aliases, relative to filesystem->storagemount
|- vmailbox path to virtual mailbox mapping, relative to filesystem->storagemount
|- vdomains path to virtual domains file (Which domains to accept mail from), relative to filesystem->storagemount
|- saslpasswd path to sasl password store file, relative to filesystem->storagemount

- setup
|- conntesthost host used for connectivity tests

- upnp
|- forwardports which ports the device shall try to forward from a UPNP gateway

- webapps
|- theme the theme used by webapps

- webcertificate
|- backend backend provider
|- enabled turns on and off generation of web certificates
|- certpath the location where signed certificate are stored
|- customcert full path to custom certificate
|- customkey full path to private key for the custom certificate

Documentation/sysconfig

2018-07-05T12:28:46Z

Tor: /* Config scopes and variables */

=System configuration file=

The kinguard system components store all generic none security sensitive configuration in a central configuration file "/etc/kinguard/sysconfig.json".

This file should however never be manually edited it should always be accessed programatically using either [https://github.com/Kinguard/libkgp libkgp] or any wrapper to this library described further down.

=== File Syntax ===
For reference here is the layout of the sysconfig json file. Please read the file for reference but never ever edit it manually.

The complete configuration file is one json object (note that javascript object syntax is not permitted).

The file is set up using a "scope" and "key/value" pairs.

All scope and key identifiers shall be lowercase and written with '''letters and digits only''', no "-" or "_".

Example:
{
"webapps":
{
"theme":"kgp"
},
"hostinfo":
{
"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939",
"hostname":"myhost",
"domain":"example.org"
}
}

=== Native access via libkgp ===
Libkgp is the main library to use when programming locally for the kinguard system it contains c++ objects for managing all kinguard functions. No official documentation exists for this yet but pointers on how it works can be found in the [https://github.com/Kinguard/libkgp/tree/master/test unit tests] and in the applications utilizing them for example [https://github.com/Kinguard/kgp-backend KGP backend] and [https://github.com/Kinguard/kgp-control KGP startup control]

To access the system configuration the [https://github.com/Kinguard/libkgp/blob/master/SysConfig.h SysConfig class]

=== Wrappers ===
Most wrappers can also be used to access other information provided by libkgp, such as the current running system type, information about system storage etc.

===== Shell Scripts =====
For shell scripts, use "[https://github.com/Kinguard/kinguard-utils kgp-sysinfo]". Run kgp-sysinfo --help for options.

Example:
# kgp-sysinfo -c hostinfo -k unitid -p
c79f425c-9af7-4f38-b1ba-d53277b14939

# kgp-sysinfo -c hostinfo -k unitid
{"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939"}

===== Python =====
For Python3, use the python library "[https://github.com/Kinguard/kgp-pywrap pylibopi]"

Example:
>>> import pylibopi
>>> pylibopi.StorageDevice()
'/dev/disk/by-path/platform-f10a8000.sata-ata-2'

===== C =====
For C programs, [https://github.com/Kinguard/libkgp_wrapper libkgp_wrapper] can be used.

===== PHP =====
Currently no native PHP wrapper exists, but kgp-sysinfo defaults to output json (see above) that can easily be used in PHP.

= Config scopes and variables =
Very few of these parameters are mandatory. However default behavior for the applications will vary if an expected parameter is missing.

- autoupdate
|- enabled turns on and off automatic updates

- backup
|- backend which storage backend to use for s3ql
|- devicemountpath where to mount local devices, such as usb memories
|- enabled turns on and off the backup service

- dns
|- dnsauthkey path to the private key used for lower level authentication on service provider backends
|- dnspubkey path to corresponding public key
|- enabled turns on and off dns updates
|- provider backend provider

- filesystem
|- storagemount mountpoint of storage volume
|- luksdevice luks-created cryptodevice (If used)
|- lvmdevice lvm-created storage pool (If used)
|- lvmvg lvm-created volume group (If used)
|- lvmlv lvm-created logical volume (If used)

- hostinfo
|- unitid system id to use as account identifier for service provider backends
|- hostname the 'host' part of the [https://en.wikipedia.org/wiki/Fully_qualified_domain_name FQDN]
|- domain the 'domain' part of the FQDN
|- cafile the ca file used to verify service provider backends
|- sysauthkey the key used to access data on service provider backends
|- syspubkey corresponding public key

- mail
|- localmail configuration file for local mail delivery, relative to filesystem->storagemount
|- virtualalias configuration file for virtual mail aliases, relative to filesystem->storagemount
|- vmailbox path to virtual mailbox mapping, relative to filesystem->storagemount
|- vdomains path to virtual domains file (Which domains to accept mail from), relative to filesystem->storagemount

- setup
|- conntesthost host used for connectivity tests

- upnp
|- forwardports which ports the device shall try to forward from a UPNP gateway

- webapps
|- theme the theme used by webapps

- webcertificate
|- backend backend provider
|- enabled turns on and off generation of web certificates
|- certpath the location where signed certificate are stored
|- customcert full path to custom certificate
|- customkey full path to private key for the custom certificate

Documentation/sysconfig

2018-07-02T14:51:35Z

Tor: /* Config scopes and variables */

=System configuration file=

The kinguard system components store all generic none security sensitive configuration in a central configuration file "/etc/kinguard/sysconfig.json".

This file should however never be manually edited it should always be accessed programatically using either [https://github.com/Kinguard/libkgp libkgp] or any wrapper to this library described further down.

=== File Syntax ===
For reference here is the layout of the sysconfig json file. Please read the file for reference but never ever edit it manually.

The complete configuration file is one json object (note that javascript object syntax is not permitted).

The file is set up using a "scope" and "key/value" pairs.

All scope and key identifiers shall be lowercase and written with '''letters and digits only''', no "-" or "_".

Example:
{
"webapps":
{
"theme":"kgp"
},
"hostinfo":
{
"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939",
"hostname":"myhost",
"domain":"example.org"
}
}

=== Native access via libkgp ===
Libkgp is the main library to use when programming locally for the kinguard system it contains c++ objects for managing all kinguard functions. No official documentation exists for this yet but pointers on how it works can be found in the [https://github.com/Kinguard/libkgp/tree/master/test unit tests] and in the applications utilizing them for example [https://github.com/Kinguard/kgp-backend KGP backend] and [https://github.com/Kinguard/kgp-control KGP startup control]

To access the system configuration the [https://github.com/Kinguard/libkgp/blob/master/SysConfig.h SysConfig class]

=== Wrappers ===
Most wrappers can also be used to access other information provided by libkgp, such as the current running system type, information about system storage etc.

===== Shell Scripts =====
For shell scripts, use "[https://github.com/Kinguard/kinguard-utils kgp-sysinfo]". Run kgp-sysinfo --help for options.

Example:
# kgp-sysinfo -c hostinfo -k unitid -p
c79f425c-9af7-4f38-b1ba-d53277b14939

# kgp-sysinfo -c hostinfo -k unitid
{"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939"}

===== Python =====
For Python3, use the python library "[https://github.com/Kinguard/kgp-pywrap pylibopi]"

Example:
>>> import pylibopi
>>> pylibopi.StorageDevice()
'/dev/disk/by-path/platform-f10a8000.sata-ata-2'

===== C =====
For C programs, [https://github.com/Kinguard/libkgp_wrapper libkgp_wrapper] can be used.

===== PHP =====
Currently no native PHP wrapper exists, but kgp-sysinfo defaults to output json (see above) that can easily be used in PHP.

= Config scopes and variables =
Very few of these parameters are mandatory. However default behavior for the applications will vary if an expected parameter is missing.

- autoupdate
|- enabled turns on and off automatic updates

- backup
|- backend which storage backend to use for s3ql
|- devicemountpath where to mount local devices, such as usb memories
|- enabled turns on and off the backup service

- dns
|- dnsauthkey path to the private key used for lower level authentication on service provider backends
|- dnspubkey path to corresponding public key
|- enabled turns on and off dns updates
|- provider backend provider

- filesystem
|- storagemount mountpoint of storage volume
|- luksdevice luks-created cryptodevice (If used)
|- lvmdevice lvm-created storage pool (If used)
|- lvmvg lvm-created volume group (If used)
|- lvmlv lvm-created logical volume (If used)

- hostinfo
|- unitid system id to use as account identifier for service provider backends
|- hostname the 'host' part of the [https://en.wikipedia.org/wiki/Fully_qualified_domain_name FQDN]
|- domain the 'domain' part of the FQDN
|- cafile the ca file used to verify service provider backends
|- sysauthkey the key used to access data on service provider backends
|- syspubkey corresponding public key

- mail
|- localmail configuration file for local mail delivery, relative to filesystem->storagemount
|- virtualalias configuration file for virtual mail aliases, relative to filesystem->storagemount

- setup
|- conntesthost host used for connectivity tests

- upnp
|- forwardports which ports the device shall try to forward from a UPNP gateway

- webapps
|- theme the theme used by webapps

- webcertificate
|- backend backend provider
|- enabled turns on and off generation of web certificates

Documentation/sysconfig

2018-07-02T14:39:12Z

Tor: /* Config scopes and variables */

=System configuration file=

The kinguard system components store all generic none security sensitive configuration in a central configuration file "/etc/kinguard/sysconfig.json".

This file should however never be manually edited it should always be accessed programatically using either [https://github.com/Kinguard/libkgp libkgp] or any wrapper to this library described further down.

=== File Syntax ===
For reference here is the layout of the sysconfig json file. Please read the file for reference but never ever edit it manually.

The complete configuration file is one json object (note that javascript object syntax is not permitted).

The file is set up using a "scope" and "key/value" pairs.

All scope and key identifiers shall be lowercase and written with '''letters and digits only''', no "-" or "_".

Example:
{
"webapps":
{
"theme":"kgp"
},
"hostinfo":
{
"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939",
"hostname":"myhost",
"domain":"example.org"
}
}

=== Native access via libkgp ===
Libkgp is the main library to use when programming locally for the kinguard system it contains c++ objects for managing all kinguard functions. No official documentation exists for this yet but pointers on how it works can be found in the [https://github.com/Kinguard/libkgp/tree/master/test unit tests] and in the applications utilizing them for example [https://github.com/Kinguard/kgp-backend KGP backend] and [https://github.com/Kinguard/kgp-control KGP startup control]

To access the system configuration the [https://github.com/Kinguard/libkgp/blob/master/SysConfig.h SysConfig class]

=== Wrappers ===
Most wrappers can also be used to access other information provided by libkgp, such as the current running system type, information about system storage etc.

===== Shell Scripts =====
For shell scripts, use "[https://github.com/Kinguard/kinguard-utils kgp-sysinfo]". Run kgp-sysinfo --help for options.

Example:
# kgp-sysinfo -c hostinfo -k unitid -p
c79f425c-9af7-4f38-b1ba-d53277b14939

# kgp-sysinfo -c hostinfo -k unitid
{"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939"}

===== Python =====
For Python3, use the python library "[https://github.com/Kinguard/kgp-pywrap pylibopi]"

Example:
>>> import pylibopi
>>> pylibopi.StorageDevice()
'/dev/disk/by-path/platform-f10a8000.sata-ata-2'

===== C =====
For C programs, [https://github.com/Kinguard/libkgp_wrapper libkgp_wrapper] can be used.

===== PHP =====
Currently no native PHP wrapper exists, but kgp-sysinfo defaults to output json (see above) that can easily be used in PHP.

= Config scopes and variables =
Very few of these parameters are mandatory. However default behavior for the applications will vary if an expected parameter is missing.

- autoupdate
|- enabled turns on and off automatic updates

- backup
|- backend which storage backend to use for s3ql
|- devicemountpath where to mount local devices, such as usb memories
|- enabled turns on and off the backup service

- dns
|- dnsauthkey the key used for lower level authentication on service provider backends
|- dnspubkey corresponding public key
|- enabled turns on and off dns updates
|- provider backend provider

- filesystem
|- storagemount mountpoint of storage volume
|- luksdevice luks-created cryptodevice (If used)
|- lvmdevice lvm-created storage pool (If used)
|- lvmvg lvm-created volume group (If used)
|- lvmlv lvm-created logical volume (If used)

- hostinfo
|- unitid system id to use as account identifier for service provider backends
|- hostname the 'host' part of the [https://en.wikipedia.org/wiki/Fully_qualified_domain_name FQDN]
|- domain the 'domain' part of the FQDN
|- cafile the ca file used to verify service provider backends
|- sysauthkey the key used to access data on service provider backends
|- syspubkey corresponding public key

- mail
|- localmail configuration file for local mail delivery, relative to filesystem->storagemount
|- virtualalias configuration file for virtual mail aliases, relative to filesystem->storagemount

- setup
|- conntesthost host used for connectivity tests

- upnp
|- forwardports which ports the device shall try to forward from a UPNP gateway

- webapps
|- theme the theme used by webapps

- webcertificate
|- backend backend provider
|- enabled turns on and off generation of web certificates

Documentation/sysconfig

2018-07-02T14:38:05Z

Tor: /* Config scopes and variables */

=System configuration file=

The kinguard system components store all generic none security sensitive configuration in a central configuration file "/etc/kinguard/sysconfig.json".

This file should however never be manually edited it should always be accessed programatically using either [https://github.com/Kinguard/libkgp libkgp] or any wrapper to this library described further down.

=== File Syntax ===
For reference here is the layout of the sysconfig json file. Please read the file for reference but never ever edit it manually.

The complete configuration file is one json object (note that javascript object syntax is not permitted).

The file is set up using a "scope" and "key/value" pairs.

All scope and key identifiers shall be lowercase and written with '''letters and digits only''', no "-" or "_".

Example:
{
"webapps":
{
"theme":"kgp"
},
"hostinfo":
{
"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939",
"hostname":"myhost",
"domain":"example.org"
}
}

=== Native access via libkgp ===
Libkgp is the main library to use when programming locally for the kinguard system it contains c++ objects for managing all kinguard functions. No official documentation exists for this yet but pointers on how it works can be found in the [https://github.com/Kinguard/libkgp/tree/master/test unit tests] and in the applications utilizing them for example [https://github.com/Kinguard/kgp-backend KGP backend] and [https://github.com/Kinguard/kgp-control KGP startup control]

To access the system configuration the [https://github.com/Kinguard/libkgp/blob/master/SysConfig.h SysConfig class]

=== Wrappers ===
Most wrappers can also be used to access other information provided by libkgp, such as the current running system type, information about system storage etc.

===== Shell Scripts =====
For shell scripts, use "[https://github.com/Kinguard/kinguard-utils kgp-sysinfo]". Run kgp-sysinfo --help for options.

Example:
# kgp-sysinfo -c hostinfo -k unitid -p
c79f425c-9af7-4f38-b1ba-d53277b14939

# kgp-sysinfo -c hostinfo -k unitid
{"unitid":"c79f425c-9af7-4f38-b1ba-d53277b14939"}

===== Python =====
For Python3, use the python library "[https://github.com/Kinguard/kgp-pywrap pylibopi]"

Example:
>>> import pylibopi
>>> pylibopi.StorageDevice()
'/dev/disk/by-path/platform-f10a8000.sata-ata-2'

===== C =====
For C programs, [https://github.com/Kinguard/libkgp_wrapper libkgp_wrapper] can be used.

===== PHP =====
Currently no native PHP wrapper exists, but kgp-sysinfo defaults to output json (see above) that can easily be used in PHP.

= Config scopes and variables =
Very few of these parameters are mandatory. However default behavior for the applications will vary if an expected parameter is missing.

- autoupdate
|- enabled turns on and off automatic updates

- backup
|- backend which storage backend to use for s3ql
|- devicemountpath where to mount local devices, such as usb memories
|- enabled turns on and off the backup service

- dns
|- dnsauthkey the key used for lower level authentication on service provider backends
|- dnspubkey corresponding public key
|- enabled turns on and off dns updates
|- provider backend provider

- filesystem
|- storagemount mountpoint of storage volume
|- luksdevice luks-created cryptodevice (If used)
|- lvmdevice lvm-created storage pool (If used)
|- lvmvg lvm-created volume group (If used)
|- lvmlv lvm-created logical volume (If used)

- hostinfo
|- unitid system id to use as account identifier for service provider backends
|- hostname the 'host' part of the [https://en.wikipedia.org/wiki/Fully_qualified_domain_name FQDN]
|- domain the 'domain' part of the FQDN
|- cafile the ca file used to verify service provider backends
|- sysauthkey the key used to access data on service provider backends
|- syspubkey corresponding public key

- mail
|- localmail configuration file for local mail delivery, relative to filesystem->storagemount
|- virtualalias configuration file for virtual mail aliases, relative to filesystem->storagemount

- setup
|- conntesthost host used for connectivity tests

- upnp
|- forwardports which ports the device shall try to forward from a UPNP gateway

- webapps
|- theme the theme used by webapps

- webcertificate
|- backend backend provider
|- enabled turns on and off generation of web certificates

Documentation/sysconfig

2018-06-06T08:08:45Z

Tor:

Documentation

2018-06-06T07:45:45Z

Tor: /* SOFTWARE COMPONENTS */

== Manual Source ==
The manual for the is written in latex and located on [https://github.com/Kinguard/manual github]
Ideally this should be adapted to better suit The Kinguard Project, so feel free to contribute.

In order for this to work, there are separate branches for different products and also a separate branch for a short one-pager.

== OPI ==

=== Manual ===
The latest compiled version is available [https://download.openproducts.com/opi/documentation/quickstart.pdf as pdf here]
=== Schematics ===
The schematics for OPI is available for download [https://download.openproducts.com/opi/documentation/OP-I_1B Rev B .pdf as pdf here]. It is in most aspects a copy of BeageBoneBlack, with the HDMI removed.

== KEEP ==

=== Manual ===
The latest compiled version is available [https://download.openproducts.com/keep/documentation/keep-quickstart.pdf as pdf here]

=== Schematics ===
KEEP is using a SOM (System On Module) from SolidRun, with 2GB DDR RAM and 8GB eMMC. The carrier board is made by [https://www.openproducts.com OpenProducts]. Schematics and component placement for that board is available [https://download.openproducts.com/keep/documentation/KEEP_R1B.pdf as pdf here].

[https://download.openproducts.com/keep/documentation/KEEP_PCB.step A stp-model] for the PCBA is also available for download (~60MB).

== Developer documentation ==
=== Software components ===
There are a number of software components available in The Kinguard Project, some of them documented here, but most is by comments in source code and available by running the application with "--help"
* System configuration (sysconfig.json). [[Documentation/sysconfig|Details]]
* System utilities, (kgp-sysinfo, kgp-notifier) [https://github.com/Kinguard/kinguard-utils Details]

Documentation

2018-06-06T07:45:18Z

Tor: /* SOFTWARE COMPONENTS */

== Manual Source ==
The manual for the is written in latex and located on [https://github.com/Kinguard/manual github]
Ideally this should be adapted to better suit The Kinguard Project, so feel free to contribute.

In order for this to work, there are separate branches for different products and also a separate branch for a short one-pager.

== OPI ==

=== Manual ===
The latest compiled version is available [https://download.openproducts.com/opi/documentation/quickstart.pdf as pdf here]
=== Schematics ===
The schematics for OPI is available for download [https://download.openproducts.com/opi/documentation/OP-I_1B Rev B .pdf as pdf here]. It is in most aspects a copy of BeageBoneBlack, with the HDMI removed.

== KEEP ==

=== Manual ===
The latest compiled version is available [https://download.openproducts.com/keep/documentation/keep-quickstart.pdf as pdf here]

=== Schematics ===
KEEP is using a SOM (System On Module) from SolidRun, with 2GB DDR RAM and 8GB eMMC. The carrier board is made by [https://www.openproducts.com OpenProducts]. Schematics and component placement for that board is available [https://download.openproducts.com/keep/documentation/KEEP_R1B.pdf as pdf here].

[https://download.openproducts.com/keep/documentation/KEEP_PCB.step A stp-model] for the PCBA is also available for download (~60MB).

== Developer documentation ==
=== SOFTWARE COMPONENTS ===
There are a number of software components available in The Kinguard Project, some of them documented here, but most is by comments in source code and available by running the application with "--help"
* System configuration (sysconfig.json). [[Documentation/sysconfig|Details]]
* System utilities, (kgp-sysinfo, kgp-notifier) [https://github.com/Kinguard/kinguard-utils Details]