1. Home
  2. Docs
  3. Documentation
  4. Getting started
  5. Install Congether

Install Congether

Debian and Ubuntu

Prerequisites

To be able to run Congether, you need to install the specific Version of .NET Core Runtime matching your operating system first.

To do this, follow the guidelines on the Microsoft web-sites.

For more informations about the required prerequisites and the Congether system-architecture, please consider following page: System architecture and prerequisites.

Install Congether

After the .NET Core Runtime is successfully installed, you can download and install Congether with following simple command.

1
curl https://static.congether.com/installation/congether-debian.sh | sudo bash

This will download and extract the current release of Congether. It will also create a systemd-deamon “congether.service”, which is used to run the application as a daemon-process.

Configure

If you use the scripted installation-method of Congether, you’re able to configure Congether by editing following file.

1
/etc/systemd/system/congether.service

In this file you’ll see following environment-variables, which are used by Congether to set the default listening-port and the database-connection.

1
2
3
Environment="Congether__Db__ConnectionString=mongodb://localhost:27017/congether"<br>
Environment="Congether__Db__DefaultDatabase=congether"<br>
Environment="Congether__Listener=http://*:5000"<br>

For more informations, about how to configure Congether read here.

Microsoft Windows

Prerequisites

If you decide to install Congether through the available install-script. .NET Core will be installed automatically. If you have problems with installing .NET Core, please follow the guidelines on the Microsoft web-site.
Download .NET Core

For more informations about the required prerequisites and the Congether system-architecture, please consider following page: System architecture and prerequisites.

Install Congether

To install Congether, use the predefined PowerShell-Installation-Script by manually downloading it here or use the following command. Please run all installations-scripts with administrative privileges in PowerShell.

1
2
Invoke-WebRequest -Uri https://static.congether.com/installation/congether-installer.ps1 -OutFile congether-install.ps1
Invoke-Expression "&amp; congether-install.ps1"

This will download and install .NET Core Congether. The default program directory will be your Program Files-Directory (e.g. C:\Program Files\Congether). To install Congether at a custom location, please use the parameter -Dir.

1
Invoke-Expression "&amp; congether-install.ps1 -Dir D:\MyInstallPath\Congether"

Configure

After the installation you’ll find the installed Congether-instance at your Program File-Directory (e.g. C:\Program Files\Congether). There you’ll find the configuration-file “appsettings.json”. For more informations, about how to configure Congether read here.

Other platforms (Binaries)

Prerequisites

To be able to run Congether, you need to install the specific Version of .NET Core Runtime matching your operating system first.

To do this, follow the guidelines on the Microsoft web-sites.
Download .NET Core

For more informations about the required prerequisites and the Congether system-architecture, please consider following page: System architecture and prerequisites.

Install Congether

After the .NET Core Runtime is successfully installed, you can download the Congether binaries from here: 

1
http://static.congether.com/releases/congether-latest.tar.gz

After the extraction you are able to run the application with following command.

1
dotnet {PATH_TO_EXTRACTED_ARCHIVE}/dotnet.dll

Extract the archive into a directory of your choice. Consider creating a platform-depending daemon/Windows Service or auto-start script. 

More packages for more platforms will follow soon.
For more informations, about how to configure Congether read here.

Configuration

Environment Variables

You can configure Congether through the use of Environment-Variables. Please set following variables to set your preferences.

1
2
3
Congether__Db__ConnectionString=mongodb://localhost:27017/congether
Congether__Db__DefaultDatabase=congether
Congether__Listener=http://*:5000

  • Congether__Db__ConnectionString: Connection-String to your MongoDB
  • Congether__Db__DefaultDatabase: Default MongoDB-Database name
  • Congether__Listener: Listener for your Congether-Service

Configuration-File

Alternatively you can configure your instance through the “appsettings.json” file in the application directory.

If there is an empty “appsettings.json”, please copy the the “appsettings.template.json” from the directory “Deploy” to the application directory and rename it.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "Congether": {
    "Db": {
      "ConnectionString": "mongodb://localhost:27017/congether",
      "DefaultDatabase": "congether"
    },
    "Listener":  "http://*:5000"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*"
}

In the section “Congether”, you can set all parameters equivalent to the use of Environment-Variables.

Additional Informations

By Default, Congether is listening to all interfaces at port “5000”. It will also connect to the local hosted MongoDB-instance at the default-port “27017”. The used default-database has the name “congether”. 

If you want to use another port or another MongoDB-instance, please provide the necessary informations here. 
Info: If you want to change the listening-port and using a HTTP/Reverse-Proxy, please consider to adapt the configuration of your proxy.

Important note: If you use the instance in a productive environment, we highly recommend to secure your MongoDB-instance through authentication. We also recommend to secure your network with a corresponding firewall-configuration.

Was this article helpful to you? Yes No

How can we help?