mirror of
https://github.com/openrport/openrport.git
synced 2025-10-26 11:27:11 +00:00
Update readme, remove plus from the apidocs
This commit is contained in:
parent
426e8d977e
commit
7629345bc2
18
README.md
18
README.md
@ -1,5 +1,7 @@
|
||||
<!-- markdownlint-disable -->
|
||||
> This a repo in an effort to continue an opensource version of original cloudradar-monitoring rport
|
||||
> This a repo in an effort to continue an opensource version of original cloudradar-monitoring rport.
|
||||
> We are working to bring back all the component to opensource. Some documentation might be inconsistent
|
||||
> but will still be usable.
|
||||
|
||||
## At a glance
|
||||
|
||||
@ -61,9 +63,9 @@ our [end-user documentation](https://kb.rport.io) with articles on user-friendly
|
||||
|
||||
### Technical documentation
|
||||
|
||||
[](https://oss.rport.io/)
|
||||
[](https://oss.openrport.io/)
|
||||
|
||||
our [technical documentation](https://oss.rport.io) with all background information and underlying concepts
|
||||
our [technical documentation](https://oss.openrport.io) with all background information and underlying concepts
|
||||
|
||||
## Feedback and Help
|
||||
|
||||
@ -74,26 +76,25 @@ To make it a success, please share your feedback.
|
||||
### Report bugs
|
||||
|
||||
If you encounter errors while installing or using Rport, please let us know.
|
||||
[File an issue report](https://github.com/realvnc-labs/rport/issues) here on GitHub.
|
||||
[File an issue report](https://github.com/openrport/openrport/issues) here on GitHub.
|
||||
|
||||
### Ask question
|
||||
|
||||
If you have difficulties installing or using rport, don't hesitate to ask us anything. Often questions give us a hint
|
||||
on how to improve the documentation. Do not use issue reports for asking questions.
|
||||
Use the [discussion forum](https://github.com/realvnc-labs/rport/discussions) instead.
|
||||
Use the [discussion forum](https://github.com/openrport/openrport/discussions) instead.
|
||||
|
||||
### Positive Feedback
|
||||
|
||||
Please share positive feedback also. Give us a star. Write a review. Share our project page on your social media.
|
||||
Contribute to the [discussion](https://github.com/realvnc-labs/rport/discussions). Is Rport suitable for your
|
||||
Contribute to the [discussion](https://github.com/openrport/openrport/discussions). Is Rport suitable for your
|
||||
needs? What is missing?
|
||||
|
||||
### Stay tuned
|
||||
|
||||
Click on the Watch button in the top right corner of the [Repository Page](https://github.com/realvnc-labs/rport).
|
||||
Click on the Watch button in the top right corner of the [Repository Page](https://github.com/openrport/openrport).
|
||||
This way you won't miss any updates and the upcoming features.
|
||||
|
||||
We send release notes over our [mailing list](https://subscribe.rport.io).
|
||||
|
||||
## Credits
|
||||
|
||||
@ -104,4 +105,3 @@ We send release notes over our [mailing list](https://subscribe.rport.io).
|
||||
|
||||
rport uses `<major>.<minor>.<buildnumber>` version pattern for compatibility with a maximum number of package managers.
|
||||
|
||||
Starting from version 1.0.0 packages with even `<minor>` number are considered stable.
|
||||
|
||||
@ -7,7 +7,7 @@ info:
|
||||
version: 1.0.0
|
||||
license:
|
||||
name: MIT
|
||||
url: https://raw.githubusercontent.com/realvnc-labs/rport/master/LICENSE
|
||||
url: https://raw.githubusercontent.com/openrport/openrport/master/LICENSE
|
||||
servers:
|
||||
- url: http://yourserver:3000/api/v1
|
||||
- url: https://yourserver:3000/api/v1
|
||||
@ -17,27 +17,22 @@ security:
|
||||
tags:
|
||||
- name: Login
|
||||
description: |
|
||||
For more details https://oss.rport.io/docs/no02-api-auth.html
|
||||
For more details https://oss.openrport.io/docs/no02-api-auth.html
|
||||
- name: Auth
|
||||
description: |
|
||||
For more details https://plus.rport.io/auth/oauth-introduction/
|
||||
- name: OAuth / Login
|
||||
description: For more details https://plus.rport.io/auth/oauth-introduction/
|
||||
For more details https://oss.openrport.io
|
||||
- name: Profile & Info
|
||||
description: Profile and System Information
|
||||
- name: Clients and Tunnels
|
||||
description: For more details https://oss.rport.io/docs/no09-managing-tunnels.html
|
||||
description: For more details https://oss.openrport.io/docs/no09-managing-tunnels.html
|
||||
- name: Client Groups
|
||||
description: For more details https://oss.rport.io/docs/no04-client-groups.html
|
||||
description: For more details https://oss.openrport.io/docs/no04-client-groups.html
|
||||
- name: Client Auth Credentials
|
||||
description: For more details https://oss.rport.io/docs/no03-client-auth.html
|
||||
description: For more details https://oss.openrport.io/docs/no03-client-auth.html
|
||||
- name: Commands
|
||||
description: For more details https://oss.rport.io/docs/no06-command-execution.html
|
||||
description: For more details https://oss.openrport.io/docs/no06-command-execution.html
|
||||
- name: Users
|
||||
description: For more details https://oss.rport.io/docs/no12-user.html
|
||||
- name: Plus
|
||||
description: |
|
||||
For more details https://plus.rport.io/auth/oauth-introduction/
|
||||
description: For more details https://oss.openrport.io/docs/no12-user.html
|
||||
paths:
|
||||
/login:
|
||||
$ref: paths/login.yaml
|
||||
@ -51,8 +46,6 @@ paths:
|
||||
$ref: paths/oauth_login.yaml
|
||||
/oauth/login/device:
|
||||
$ref: paths/oauth_login_device.yaml
|
||||
/plus/status:
|
||||
$ref: paths/plus_status.yaml
|
||||
/logout:
|
||||
$ref: paths/logout.yaml
|
||||
/verify-2fa:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user