Skip to content

netzint/openrport

 
 

Repository files navigation

OpenRPort

Installation

Info

The following configuration is avaliable for the installation process:

## Define a custom repository URL for the client installers.
## Defaults to https://github.com/netzint/openrport
repository_url = "https://github.com/netzint/openrport"

## You can define custom names for the generated client installers. This is to whitelabel the client on the systems.
## Defaults to "openrport"
installer_name = "openrport"

## By default, each generated client installer is pre-registered on the server.
## This means, the client is ready to connect right after installation without any further manual steps.
## If you turn this off, each client must be registered manually after installation.
## Defaults to true
installer_autoregister = true

If installer_autoregister is set to true, the client auth is created with a random password and injected to the install script. If the client auth already exist on the server, you receive a HTTP 409 error. You can add &replace=true to the URL to delete the old client auth and automatically create new credentials.

Linux installation

curl -fsSL "https://your-server/client/install?name=myserver" | bash

Windows installation (PowerShell)

iwr "https://your-server/client/install?name=myserver&os=windows" | iex

Update

Linux update

curl -fsSL "https://your-server/client/update" | bash

Windows update (PowerShell)

iwr "https://your-server/client/update?os=windows" | iex

Uninstall

Linux uninstall

curl -fsSL "https://your-server/client/uninstall" | bash

Windows uninstall (PowerShell)

iwr "https://your-server/client/uninstall?os=windows" | iex

Configuration

Global command configuration

# It is possible to specify a list of allow commands that can be executed on clients via rport server.
# The commands can be defined in a TOML file for each operating system. The list is send to clients during
# the connection setup.
# Defaults to not set
command_policy_file =  "/etc/rport/command-policy.toml"

/etc/rport/command-policy.toml

[linux]
allow = [
  '/usr/bin/apt-get update',
  '/usr/bin/apt-get upgrade -y',
]

[windows]
allow = [
  'C:\\Windows\\System32\\ipconfig.exe /all',
]

[global]
allow = [
  'hostname',
]

About

Manage remote systems with ease. See more https://oss.openrport.io

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 56.8%
  • CSS 42.8%
  • Other 0.4%