mirror of
https://github.com/openrport/openrport.git
synced 2025-10-26 11:27:11 +00:00
Changing default pairing url to pairing.openrport.io
This commit is contained in:
alhdo
Castro Alhdo
parent
129099419e
commit
fdb5ec707e
@ -61,18 +61,18 @@ binaries only for Linux X64 because this is the ideal platform for running it se
|
||||
|
||||
## Instantly launch an RPort server
|
||||
|
||||
[](https://kb.rport.io/install-the-rport-server)
|
||||
[](https://kb.openrport.io/install-the-rport-server)
|
||||
|
||||
🚀 If you are curious and want to try RPort, install your server now in no time. Use our
|
||||
[server installation script](https://kb.rport.io/install-the-rport-server).
|
||||
[server installation script](https://kb.openrport.io/install-the-rport-server).
|
||||
|
||||
## 📖 Documentation
|
||||
|
||||
### End-User documentation
|
||||
|
||||
[](https://kb.rport.io)
|
||||
[](https://kb.openrport.io)
|
||||
|
||||
our [end-user documentation](https://kb.rport.io) with articles on user-friendly installation, settings and secure operation of RPort.
|
||||
our [end-user documentation](https://kb.openrport.io) with articles on user-friendly installation, settings and secure operation of RPort.
|
||||
|
||||
### Technical documentation
|
||||
|
||||
|
||||
@ -112,7 +112,7 @@
|
||||
## Rport can constantly summarize pending updates and
|
||||
## make that summary available on the rport server.
|
||||
## On Debian/Ubuntu and SuSE Linux sudo rules are needed.
|
||||
## https://oss.rport.io/advanced/supervising-update-status/
|
||||
## https://oss.openrport.io/advanced/supervising-update-status/
|
||||
## How often after the rport client has started pending updates are summarized
|
||||
## Set 0 to disable.
|
||||
## Supported time units: h (hours), m (minutes)
|
||||
@ -150,7 +150,7 @@
|
||||
## Write a state file to {data_dir}/state.json that can be evaluated by external watchdog implementations.
|
||||
## On Linux this also enables the systemd watchdog integration by using the systemd notify socket.
|
||||
## Requires max_retry_count = -1 and keep_alive > 0
|
||||
## Read more https://oss.rport.io/advanced/watchdog-integration/
|
||||
## Read more https://oss.openrport.io/advanced/watchdog-integration/
|
||||
## Disabled by default.
|
||||
#watchdog_integration = false
|
||||
|
||||
@ -224,7 +224,7 @@
|
||||
|
||||
[monitoring]
|
||||
## The rport client can collect and report performance data of the operating system.
|
||||
## https://oss.rport.io/advanced/monitoring/
|
||||
## https://oss.openrport.io/advanced/monitoring/
|
||||
## Monitoring is enabled by default
|
||||
enabled = true
|
||||
|
||||
@ -278,7 +278,7 @@
|
||||
## For fast and unified script execution with different interpreters and shells,
|
||||
## you can specify aliases. Instead of providing the full path to the shell,
|
||||
## sending the alias is sufficient.
|
||||
## https://oss.rport.io/get-started/scripts/#customizing-an-interpreter
|
||||
## https://oss.openrport.io/get-started/scripts/#customizing-an-interpreter
|
||||
## Optionally you can also specify input and output encoding.
|
||||
## If only one encoding is specified it will be used for both input and output.
|
||||
## Examples:
|
||||
@ -290,7 +290,7 @@
|
||||
## Receive files pushed by the server, enabled by default
|
||||
# enabled = true
|
||||
## The rport client will reject writing files to any of the following folders and its sub folders.
|
||||
## https://oss.rport.io/advanced/file-reception/
|
||||
## https://oss.openrport.io/advanced/file-reception/
|
||||
## Wildcards (glob) are supported.
|
||||
## Linux defaults
|
||||
# protected = ['/bin', '/sbin', '/boot', '/usr/bin', '/usr/sbin', '/dev', '/lib*', '/run']
|
||||
|
||||
@ -41,8 +41,8 @@
|
||||
#tunnel_host = "tunnels.rport.example.com"
|
||||
|
||||
## Optionally defines a custom pairing service URL.
|
||||
## Defaults to https://pairing.rport.io
|
||||
## To run your own pairing service, refer to https://github.com/cloudradar-monitoring/rport-pairing
|
||||
## Defaults to https://pairing.openrport.io
|
||||
## To run your own pairing service, refer to https://github.com/openrport/rport-pairing
|
||||
## Accepts a single string like
|
||||
#pairing_url = "https://pairing.example.com"
|
||||
|
||||
@ -71,7 +71,7 @@
|
||||
## An optional name of a database table for client authentication.
|
||||
## Requires a global database connection. See below.
|
||||
## The table must be created manually.
|
||||
## Learn how to create them https://oss.rport.io/get-started/client-authentication/#using-a-database-table
|
||||
## Learn how to create them https://oss.openrport.io/get-started/client-authentication/#using-a-database-table
|
||||
#auth_table = "clients_auth"
|
||||
|
||||
## When using an {auth_file} or a database table, creating separate credentials for each client is recommended.
|
||||
@ -180,7 +180,7 @@
|
||||
## 'client-listener: Failed login attempt for client auth id "abc", forcing to wait for {client_login_wait}s ({ip})'
|
||||
## is logged to the info log.
|
||||
## Consider changing the log_level to 'info' to trace failed login attempts.
|
||||
## Learn more https://oss.rport.io/advanced/securing-the-rport-server/
|
||||
## Learn more https://oss.openrport.io/advanced/securing-the-rport-server/
|
||||
## Defaults: 2.0
|
||||
#client_login_wait = 2.0
|
||||
|
||||
@ -191,7 +191,7 @@
|
||||
## is logged to the info log.
|
||||
## Banning happens on HTTP level.
|
||||
## Consider banning on network level using fail2ban.
|
||||
## Learn more https://oss.rport.io/advanced/securing-the-rport-server/
|
||||
## Learn more https://oss.openrport.io/advanced/securing-the-rport-server/
|
||||
## Defaults: max_failed_login = 5, ban_time = 3600
|
||||
#max_failed_login = 5
|
||||
#ban_time = 3600
|
||||
@ -231,14 +231,14 @@
|
||||
address = "0.0.0.0:3001"
|
||||
|
||||
## Defines <user>:<password> authentication pair for accessing the API. Enables access for a single user.
|
||||
## Learn more about api auth options and get examples https://oss.rport.io/get-started/api-authentication/
|
||||
## Learn more about api auth options and get examples https://oss.openrport.io/get-started/api-authentication/
|
||||
## Use either {auth_file}/{auth_user_table} or {auth}. Not both.
|
||||
## If multiple auth options are enabled, rportd exits with an error.
|
||||
auth = "admin:foobaz"
|
||||
|
||||
## Use a json file containing users, passwords and groups.
|
||||
## Passwords are expected to be bcrypt encoded.
|
||||
## Learn more about api auth options and get examples https://oss.rport.io/get-started/api-authentication/
|
||||
## Learn more about api auth options and get examples https://oss.openrport.io/get-started/api-authentication/
|
||||
## Use either {auth_file}/{auth_user_table} or {auth}. Not both.
|
||||
## If multiple auth options are enabled, rportd exits with an error.
|
||||
#auth_file = "/var/lib/rport/api-auth.json"
|
||||
@ -246,7 +246,7 @@
|
||||
## An optional name of database tables for api user authentication.
|
||||
## Requires a global database connection. See below.
|
||||
## Tables must be created manually.
|
||||
## Learn how to create them https://oss.rport.io/get-started/api-authentication/#database
|
||||
## Learn how to create them https://oss.openrport.io/get-started/api-authentication/#database
|
||||
#auth_user_table = "users"
|
||||
#auth_group_table = "groups"
|
||||
#auth_group_details_table = "group_details"
|
||||
@ -265,7 +265,7 @@
|
||||
#default_user_group = "Administrators"
|
||||
|
||||
## Use two-factor authentication to generate auth tokens.
|
||||
## Learn more on https://oss.rport.io/get-started/api-authentication/#two-factor-auth
|
||||
## Learn more on https://oss.openrport.io/get-started/api-authentication/#two-factor-auth
|
||||
## Using 2FA will disable HTTP basic authentication on all API endpoints except '/login'. It triggers sending 2FA
|
||||
## verification code to a user using a chosen delivery method. This code can be further verified using '/verify-2fa' endpoint.
|
||||
## Two-factor authentication requires either a valid SMTP or Pushover setup.
|
||||
@ -291,7 +291,7 @@
|
||||
## set 'totp_enabled = true'.
|
||||
## Your user-password store (json files or DB table) needs an additional text field 'totp_secret'.
|
||||
#totp_enabled = false
|
||||
## Learn more on https://oss.rport.io/get-started/api-authentication/#two-factor-auth
|
||||
## Learn more on https://oss.openrport.io/get-started/api-authentication/#two-factor-auth
|
||||
## Before sending the token generated by the authenticator app,
|
||||
## users should do a login attempt. Otherwise, they can request tokens directly without login.
|
||||
## 'totp_login_session_ttl' sets the timeout after which totp codes won't be accepted
|
||||
@ -311,7 +311,7 @@
|
||||
|
||||
## If specified, rportd will serve static files from this directory on the same API address.
|
||||
## This is the place where the frontend files (html/js) go.
|
||||
## Learn how to install the frontend https://oss.rport.io/get-started/rport-frontend/
|
||||
## Learn how to install the frontend https://oss.openrport.io/get-started/rport-frontend/
|
||||
doc_root = "./rd-test-resources/ui"
|
||||
|
||||
## If both cert_file and key_file are specified, then rportd will use them to serve the API with https.
|
||||
@ -372,7 +372,7 @@
|
||||
|
||||
## The maximum upload size of a file in bytes.
|
||||
## If exceeded, an error is returned. Please note that max_request_bytes is not affecting the file upload API
|
||||
## https://oss.rport.io/advanced/file-reception/
|
||||
## https://oss.openrport.io/advanced/file-reception/
|
||||
## Defaults: 10485760 bytes (~ 10.5 MB).
|
||||
#max_filepush_size = 10485760
|
||||
|
||||
@ -385,8 +385,8 @@
|
||||
## Global configuration of a database connection.
|
||||
## The database and the initial schema must be created manually.
|
||||
## Learn how to use a database:
|
||||
## for api auth: https://oss.rport.io/get-started/api-authentication/#database
|
||||
## for clients auth: https://oss.rport.io/get-started/client-authentication/#using-a-database-table
|
||||
## for api auth: https://oss.openrport.io/get-started/api-authentication/#database
|
||||
## for clients auth: https://oss.openrport.io/get-started/client-authentication/#using-a-database-table
|
||||
## Supported: MySQL/MariaDB and Sqlite3
|
||||
|
||||
## For MySQL or MariaDB.
|
||||
@ -411,7 +411,7 @@
|
||||
|
||||
[caddy-integration]
|
||||
## Enable https tunnels on random subdomains.
|
||||
## See https://oss.rport.io/advanced/tunnels-on-subdomains/
|
||||
## See https://oss.openrport.io/advanced/tunnels-on-subdomains/
|
||||
## Note: no defaults currently.
|
||||
|
||||
## Specifies the path to the caddy executable. mandatory.
|
||||
@ -436,14 +436,14 @@
|
||||
|
||||
[pushover]
|
||||
## Pushover settings for sending push messages via Pushover.net. Currently, used only for sending two-factor auth tokens.
|
||||
## Learn more on https://oss.rport.io/get-started/2fa-messaging/#pushover
|
||||
## Learn more on https://oss.openrport.io/get-started/2fa-messaging/#pushover
|
||||
## Required (only if pushover is specified as {api.two_fa_token_delivery}): pushover API token and user key
|
||||
#api_token = 'abc123'
|
||||
#user_key = 'user123'
|
||||
|
||||
[smtp]
|
||||
## SMTP settings for sending email. Currently, used only for sending two-factor auth tokens.
|
||||
## Learn more on https://oss.rport.io/get-started/2fa-messaging/#smtp
|
||||
## Learn more on https://oss.openrport.io/get-started/2fa-messaging/#smtp
|
||||
## Required (only if smtp is specified as {api.two_fa_token_delivery}):
|
||||
## smtp server and port separated by a colon. e.g. server = 'smtp.gmail.com:2525'
|
||||
## sender email - an email that is used to send 2FA tokens
|
||||
@ -458,7 +458,7 @@
|
||||
#secure = false
|
||||
|
||||
[monitoring]
|
||||
## https://oss.rport.io/advanced/monitoring/
|
||||
## https://oss.openrport.io/advanced/monitoring/
|
||||
## Global switch to turn off monitoing system wide. Any monitoring settings on
|
||||
## client side will be ignored. Switched on by default.
|
||||
#enabled = true
|
||||
|
||||
@ -6,9 +6,9 @@
|
||||
#
|
||||
# DESCRIPTION: Configuration file for the rport client
|
||||
#
|
||||
# BUGS: https://github.com/realvnc-labs/rport/issues
|
||||
# BUGS: https://github.com/openrport/openrport/issues
|
||||
#
|
||||
# HELP: https://github.com/realvnc-labs/rport/blob/master/README.md
|
||||
# HELP: https://github.com/openrport/openrport/blob/master/README.md
|
||||
#
|
||||
# COPYRIGHT: (c) 2020 by the CloudRadar Team,
|
||||
#
|
||||
@ -16,6 +16,7 @@
|
||||
# ORGANIZATION: RealVNC Limited, Cambridge, United Kingdom (realvnc.com)
|
||||
# CREATED: 10/10/2020
|
||||
# UPDATED: 27/10/2022
|
||||
# MAINTAINER: OpenRport, France, Lille
|
||||
#======================================================================================================================
|
||||
|
||||
[client]
|
||||
@ -60,7 +61,7 @@
|
||||
#name = "my_win_vm_1"
|
||||
|
||||
## A list of of tags and labels to give your clients attributes maintained in a separate file.
|
||||
## See https://oss.rport.io/advanced/attributes/
|
||||
## See https://oss.openrport.io/advanced/attributes/
|
||||
#attributes_file_path = "/var/lib/rport/client_attributes.(yaml|json|toml)"
|
||||
#attributes_file_path = "C:\Program Files\rport\client_attributes.(yaml|json|toml)"
|
||||
## Alternatively you can specify tags with the line below if {attributes_file_path} is not set.
|
||||
@ -115,7 +116,7 @@
|
||||
## Rport can constantly summarize pending updates and
|
||||
## make that summary available on the rport server.
|
||||
## On Debian/Ubuntu and SuSE Linux sudo rules are needed.
|
||||
## https://oss.rport.io/advanced/supervising-update-status/
|
||||
## https://oss.openrport.io/advanced/supervising-update-status/
|
||||
## How often after the rport client has started pending updates are summarized
|
||||
## Set 0 to disable.
|
||||
## Supported time units: h (hours), m (minutes)
|
||||
@ -134,8 +135,8 @@
|
||||
#bind_interface = "eth0"
|
||||
|
||||
## Determine the clients' external ipv4 and ipv6 addresses by fetching an API.
|
||||
## See https://oss.rport.io/advanced/ip-address-determination/
|
||||
#ip_api_url = "https://myip.rport.io"
|
||||
## See https://oss.openrport.io/advanced/ip-address-determination/
|
||||
#ip_api_url = "https://myip.openrport.io"
|
||||
## How often (in minutes) to refresh external IP addresses, default 30
|
||||
#ip_refresh_min = 30
|
||||
|
||||
@ -159,7 +160,7 @@
|
||||
## Write a state file to {data_dir}/state.json that can be evaluated by external watchdog implementations.
|
||||
## On Linux this also enables the systemd watchdog integration by using the systemd notify socket.
|
||||
## Requires max_retry_count = -1 and keep_alive > 0
|
||||
## Read more https://oss.rport.io/advanced/watchdog-integration/
|
||||
## Read more https://oss.openrport.io/advanced/watchdog-integration/
|
||||
## Disabled by default.
|
||||
#watchdog_integration = false
|
||||
|
||||
@ -233,7 +234,7 @@
|
||||
|
||||
[monitoring]
|
||||
## The rport client can collect and report performance data of the operating system.
|
||||
## https://oss.rport.io/advanced/monitoring/
|
||||
## https://oss.openrport.io/advanced/monitoring/
|
||||
## Monitoring is enabled by default
|
||||
enabled = true
|
||||
|
||||
@ -287,7 +288,7 @@
|
||||
## For fast and unified script execution with different interpreters and shells,
|
||||
## you can specify aliases. Instead of providing the full path to the shell,
|
||||
## sending the alias is sufficient.
|
||||
## https://oss.rport.io/get-started/scripts/#customizing-an-interpreter
|
||||
## https://oss.openrport.io/get-started/scripts/#customizing-an-interpreter
|
||||
## Optionally you can also specify input and output encoding.
|
||||
## If only one encoding is specified it will be used for both input and output.
|
||||
## Examples:
|
||||
@ -299,7 +300,7 @@
|
||||
## Receive files pushed by the server, enabled by default
|
||||
# enabled = true
|
||||
## The rport client will reject writing files to any of the following folders and its sub folders.
|
||||
## https://oss.rport.io/advanced/file-reception/
|
||||
## https://oss.openrport.io/advanced/file-reception/
|
||||
## Wildcards (glob) are supported.
|
||||
## Linux defaults
|
||||
# protected = ['/bin', '/sbin', '/boot', '/usr/bin', '/usr/sbin', '/dev', '/lib*', '/run']
|
||||
|
||||
Loading…
Reference in New Issue
Block a user