Skip to content

Commit 19d4a22

Browse files
VShawnVShawn
committed
add quickstart.md
1 parent ada0a3d commit 19d4a22

File tree

3 files changed

+215
-4
lines changed

3 files changed

+215
-4
lines changed

‎source/docs/index.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,60 @@
22

33
{{name}} is a remote access manager and connection launcher for Windows OS. It comes integrated with a number of different protocols but also provides extensibility options via existing CLI tools implementing any kind of protocol.
44

5+
6+
<img src="https://raw.githubusercontent.com/1Remote/PRemoteM/Doc/DocPic/maindemo.png" width="800" />
7+
58
## Features
69

710
- OTB support for RDP, SSH, VNC, Telnet, (S)FTP, RemoteApp, NoMachine
811
- Quick and convenient remote session launcher
912
- Multi-screen and HiDPI RDP connection
13+
- Multi-address and Multi-account for your session
1014
- Detailed connection configuration: tags, icons, colors, connection scripts etc.
1115
- Multiple languages, themes and tabbed interface
12-
- Connection import from mRemoteNG
13-
- Password encryption via RSA
14-
- Customizable protocols
16+
- Connection import from mRemoteNG, .rdp file
17+
- Customizable protocols, choose your favorite tools for each protocol (e.g. WinSCP for SFTP / TigerVNC for VNC)
1518
- Portable mode
19+
- Sync your sessions between several machines via Dropbox, Google Drive, OneDrive, etc.
20+
- Sharing sessions with others via mysql database in a small team.
21+
22+
23+
## Installation
24+
25+
### Requirements
26+
27+
- [Windows10 17763 and above](https://support.lenovo.com/us/en/solutions/ht502786)
28+
- [.NET 6 Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/6.0/runtime)
29+
> P.S. You can clone the code and build with `ReleaseNet48` if you are likely to use 1Remote in Win7.
30+
31+
Use one of the following methods to install the application:
32+
33+
- [GitHub release](https://github.com/1Remote/1Remote/releases)
34+
- [Microsoft Store](https://www.microsoft.com/store/productId/9PNMNF92JNFP)
35+
<!-- - Using [Winget](https://github.com/microsoft/winget-cli): `winget install premotem`
36+
- [Chocolatey](https://chocolatey.org/packages/premotem): `choco install premotem` -->
37+
38+
<!-- ## Pricing
39+
Free for personal use.
40+
Team and Enterprise pricing available. -->
41+
42+
### Quick start
43+
44+
1. Open 1Remote.exe, open the main window.
45+
46+
2. Click "+" button then fill address\username\password... and save
47+
48+
3. In main window, double click to open connection.
49+
50+
4. Press <kbd>Alt</kbd> + <kbd>M</kbd> Open the launcher, type keyword to find your server, press <kbd>enter</kbd> to start session
51+
52+
## Make 1Remote Stronger
53+
54+
If you like this app, please help us make it stronger by doing any of the following:
1655

17-
!!! todo
56+
1. [Simply star it on github](https://github.com/1Remote/1Remote/)
57+
2. [Help translation](https://github.com/1Remote/1Remote/wiki/Help-wanted:-Translation)
58+
3. [Buy a coffee](https://ko-fi.com/VShawn)
59+
4. [Join DEV](DEVELOP.md)
1860

1961
{% include 'footer.md' %}

‎source/docs/quickstart.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# 1Remote Quick Start
2+
3+
## Adding Servers
4+
5+
### Manually Adding a Server
6+
7+
1. Click the `+` button in the upper-right corner of the main window.
8+
2. Choose a protocol, such as RDP, SSH, or VNC, at the top of the pop-up window.
9+
3. Enter the server's name, label, notes (supports Markdown), and other information.
10+
4. (Optional) Customize the server icon (system-built or manually uploaded) and highlight color (default is no highlight, setting a highlight color will highlight the server in the list and connection process).
11+
5. (Optional) Configure scripts for the server, such as opening VPN before starting remote desktop, or closing VPN after closing remote desktop. Scripts support cmd, PowerShell, and Python.
12+
6. Continue entering server address, port, username, password, and other information, and select your desired connection settings.
13+
7. Click the `Save` button to complete adding the server and return to the homepage.
14+
15+
### Importing Servers from mRemoteNG
16+
17+
1. In mRemoteNG, right-click on the server and choose "Export to File...". Set the "File Format" to "mRemoteNG CSV" in the pop-up window, and click the `OK` button in the lower-right corner to export.
18+
2. In 1Remote, click the `+` button in the upper-right corner of the main window, and choose "import mRemoteNG csv". Select the CSV file you just exported in the pop-up dialog, and click "Open" to complete the import.
19+
20+
### Importing Servers from RDP Files
21+
22+
1. In MSTSC.exe, click "Show Options" to expand the window, click the `Save As...` button under "Connection settings", and save as an RDP file.
23+
2. In 1Remote, click the `+` button in the upper-right corner of the main window, and choose "import *.rdp". Select the RDP file you just saved in the pop-up dialog, and click "Open" to complete the import.
24+
25+
## Starting Remote Connections
26+
27+
### Starting from the main window
28+
29+
1. Servers are displayed in the main window as cards or lists. Double-click a server to open the corresponding remote session.
30+
2. You can also check the checkbox in front of each server, and then click the `Connect` button at the bottom of the main window to start multiple remote sessions at once.
31+
3. If you have labeled the servers, you can right-click the label in the label list above the main window, and click the `Connect` button to start multiple remote sessions at once.
32+
33+
### Starting from the Launcher
34+
35+
1. If you have enabled the Launcher feature, you can use the default shortcut <Alt> + <M> to open the quick start window of the server.
36+
2. Servers are arranged in order of recent use in the Launcher window. Use the up and down arrow keys to select the desired server, or search for the desired server directly by entering keywords.
37+
3. After selecting the server, press the <Enter> key to start the remote session.
38+
39+
## Managing Servers
40+
41+
### Basic Management
42+
43+
1. Servers are displayed in the main window as cards or lists. You can click the `Settings` button in the upper-right corner of the interface to expand the menu and choose "Toggle Cards/List" to switch the display mode of servers.
44+
2. In list mode, click on the header above the list to sort the servers.
45+
3. When you hover your mouse over a server, the corresponding `Settings` button will be displayed. Clicking on this button will display a menu where you can connect to, edit, create a replica, delete, copy the server address and account password, etc. (Note: If you connect to a MySQL server with read-only permissions, you will not be able to edit, copy, or delete server information stored in that database.)
46+
4. You can also directly enter the edit interface by right-clicking on a server with your mouse.
47+
5. By selecting multiple servers using the checkboxes and clicking the `Edit` button at the bottom of the main window, you can enter the batch editing interface to perform uniform editing operations on multiple servers. With proper server labels, you can easily select all servers under a specific label and modify their addresses or account passwords in bulk.
48+
49+
### Data Backup and Synchronization
50+
51+
- Data export: By selecting multiple servers using the checkboxes and clicking the `Export` button at the bottom of the main window, you can export the server information to a JSON file. (Note that the exported data is stored in plain text, so please handle it with care.)
52+
- Database backup: Click the `Settings` button in the top right corner of the main window, expand the menu, select the `Options` button, and go to the Database tab. Find the database named "Local" and you can see its storage path. You can manually enter this path to backup the database.
53+
- Database synchronization: If you use multiple devices, you can back up the database to the cloud and set the synchronization path on each device, so that you can share server information across different devices.
54+
1. First, move the "Local" database file to the sync folder. Synology NAS, OneDrive, Google Drive, and other cloud storage services can be used as sync service providers.
55+
2. Click the Edit `button` to the right of the "Local" database in the `Database` tab, then click the `Select` button in the pop-up window and choose the database file you moved to the sync folder. Save the changes.
56+
3. The app will check whether the database file has changed every once in a while. If changes are detected, the file will be automatically synchronized to the database.
57+
4. (Note: This app does not use concurrency locks on the data, so if you modify the database on multiple devices at the same time, data loss may occur. Please try to avoid this situation.)
58+
59+
### Adding Multiple Databases
60+
61+
1Remote supports various data sources such as local SQLite databases and online MySQL databases. You can connect to multiple databases at the same time, which allows you to store different server information in different databases and connect to different databases on different devices for flexible data management.
62+
63+
A typical use case is when you need to manage your personal servers (e.g. blog server, online photo server), as well as several servers in your team for work. You may face the following challenges:
64+
65+
- Your personal server can only be managed by yourself.
66+
- The team's servers need to be shared among several colleagues.
67+
- Only you and your boss can add and modify servers, while other colleagues can only use the servers listed.
68+
69+
This is where configuring multiple databases becomes useful:
70+
71+
- Your personal server information is stored in the default "Local" database, which only you can see and use.
72+
- The team's servers are stored in a MySQL database named "Team." You and your boss can connect with an administrator account to add and modify servers, while other colleagues can only read the server list with a read-only account. Specifically:
73+
1. Install MySQL. In this article, we use the Synology package to install and deploy MySQL.
74+
2. Create a new database in MySQL. Here, we create a database named session_ai, which doesn't need to have any tables.
75+
3. Create a new account named session_admin in MySQL and grant it all privileges to the session_ai database.
76+
4. On the "Database" tab page in the "Setting" section of 1Remote, click the `Add` button in the upper right corner to add a new MySQL database.
77+
5. Go back to the main page of 1Remote and click the `+` button in the upper right corner to add a new server configuration to the newly added database.
78+
6. Create a new account named session_user in MySQL and only grant it select permission to the session_ai database. Distribute this account to your team members so that they can read the server configuration stored in the session_ai database but cannot view or modify their passwords.
79+
7. Noted: 1Remote updates data by querying periodically. Therefore, when you modify server information, other users may need to wait for several seconds before they can get the latest data.
80+
81+
## Customization
82+
83+
- Change language: "Setting" -> "General" -> "Language"
84+
- Change theme: "Setting" -> "Theme" -> "Theme". On this page, you can also customize your favorite color scheme.
85+
- Change SSH color scheme: "Setting" -> "Protocol" -> "SSH" -> "KiTTY" -> "Themes"

‎source/docs/quickstart_zh-cn.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# 快速开始
2+
3+
## 添加服务器
4+
5+
### 手动添加服务器
6+
7+
1. 点击主界面右上角的 `+` 按钮
8+
2. 在弹出的界面最上方选择协议，例如RDP、SSH、VNC等
9+
3. 输入服务器的名称、标签、备注（支持markdown格式）等信息
10+
4. （可选）此时您可以为服务器定制图标（可以使用系统内置图标或者手动上传）和高亮色(默认为无高亮，设置高亮色后将在列表和连接过程中对该服务器用高亮色标注)
11+
5. （可选）为服务器配置脚本，例如你可以在启动远程桌面前先用脚本打开VPN，或者在关闭远程桌面后关闭VPN，脚本支持 cmd、powershell、python。
12+
6. 继续输入服务器地址、端口、用户名、密码等信息，选择您希望的连接设置
13+
7. 点击保存按钮，即可完成服务器的添加并回到主页
14+
15+
### 从 mRemoteNG 导入服务器
16+
17+
1. 在 mRemoteNG 中，右键点击服务器，选择“Export to File...”，然后在弹出的页面中把 `File Format` 设置为 `mRemoteNG CSV`，最后点击右下角的 OK 按钮完成导出。
18+
2. 在 1Remote 中，点击主界面右上角的 `+` 按钮，选择 “import mRemoteNG csv”，在弹出的对话框中选择刚才导出的csv文件，点击打开即可完成导入。
19+
20+
### 从 rdp 文件导入服务器
21+
22+
1. 在 MSTSC.exe 中点击 `Show Options` 展开窗口，点击 `Connection settings` 中的 `Save As...` 按钮，保存为 rdp 文件
23+
2. 在 1Remote 中，点击主界面右上角的 `+` 按钮，选择 `import *.rdp`，在弹出的对话框中选择刚才导出的rdp文件，点击打开即可完成导入。
24+
25+
## 启动远程连接
26+
27+
### 从主界面启动
28+
29+
1. 服务器在主界面以卡片或列表的形式展示，双击服务器即可打开对应的远程会话。
30+
2. 你还可以勾选每个服务器前面的复选框，然后点击主界面下方的“Connect”按钮，一次性启动多个远程会话。
31+
3. 如果你为服务器配置了标签，你可以在主界面上方标签列表中右键点击标签，然后点击“Connect”按钮，一次性启动多个远程会话。
32+
33+
### 从 Launcher 启动
34+
35+
1. 如果您开启了 Launcher 功能，你可以通过默认快捷键 <kbd>Alt</kbd> + <kbd>M</kbd> 打开服务器的快速启动窗口。
36+
2. 在 Launcher 窗口中服务器被以最近使用的顺序排列，通过方向键上下你可以选择所需的服务器，或者直接输入关键字搜索所需服务器。
37+
3. 选中服务器后，按下 <kbd>Enter</kbd> 键即可启动远程会话。
38+
39+
## 管理服务器
40+
41+
### 基本管理
42+
43+
1. 服务器在主界面以卡片或列表的形式展示，你可以通过点击界面右上角设置按钮展开菜单中的 `Toggle Cards/List` 来切换服务器的展示方式
44+
2. 在列表模式下，可以点击列表上方的 header，实现对服务器的排序
45+
3. 当鼠标悬浮在服务器上方时，对应的设置按钮会被显示出来，点击该按钮可以在其展开菜单中执行连接、编辑、创建副本、删除、复制服务器地址和账号密码等操作（注意：如果你以只读用权限连接到mysql服务器时，无法编辑、复制、或删除该数据库中存储的服务器信息）
46+
4. 直接鼠标右键点击服务器也可以直接进入编辑界面
47+
5. 通过复选框选择多个服务器后，点击主界面下方的“Edit”按钮，可以进入批量编辑界面，对多个服务器进行统一的编辑操作，配合合理的服务器标签，可以方便地全选某一个标签下的所有服务器，并批量修改它们的地址或账号密码
48+
49+
### 数据备份和同步
50+
51+
- 数据导出：通过复选框选择多个服务器后，点击主界面下方的“Export”按钮，可以将服务器信息导出到 json 文件。（*注意导出到json后的数据是**明文**存储的，请务必妥善保管*）
52+
- 数据库备份：点击主界面右上角设置按钮展开菜单中的 `Options` 按钮，进入设置界面并选择`Database`选项卡，找到名称为“Local”的数据库，可以看到它的存储路径，你可以手动进入该路径并备份数据库。
53+
- 数据库同步：如果你使用了多台设备，你可以将数据库备份到云端，然后在每台设备上设置同步数据库的路径，这样你就可以在不同的设备上共享服务器信息了。
54+
1. 首先将“Local”数据库文件移动到同步文件夹，群晖、OneDrive、Google drive等云盘都可以作为同步服务的提供商。
55+
2. 点击`Database`选项卡中，“Local”的数据库右侧的 `Edit` 按钮，在弹出的界面再点击 `Select` 按钮，选择你放到同步文件夹的数据库文件，保存即可。
56+
3. APP 将每隔一定时间检测数据库文件是否有变化，如果有变化，将会自动同步到数据库中。(注意：本 APP 并没有对数据做并发锁，所以如果你在多台设备上同时修改了数据库，可能会导致数据丢失，所以请尽量避免这种情况发生。)
57+
58+
### 添加多个数据库
59+
60+
1Remote 支持多种数据源，例如本地数据库 SQLite，在线数据库 MySQL 等。你可以同时连接到多个数据库，这样你就可以在不同的数据库中存储不同的服务器信息，然后在不同的设备上连接到不同的数据库，实现灵活的数据管理。
61+
62+
一个典型的应用场景是你需要管理自己私人的博客服务器、在线照片服务器等，与此同时你还需要管理你工作中你所在团队的几个服务器。此时你面临这样的问题：
63+
64+
- 你的私人服务器只能你自己一个人管理
65+
- 你所在团队的服务器需要在多个同事之间共享使用
66+
- 只有你和你的BOSS能添加和修改服务器，其他同事则只能使用列表中的服务器
67+
68+
此时多数据库配置便派上用场了
69+
70+
- 你的私人服务器信息存储在默认的“Local”的数据库中，只有你能看到和使用
71+
- 团队的服务器存在一个名为“Team”的MySQL数据库中，你和你的BOSS使用管理员账号连接可以添加和修改服务器，其他同事用只读账号连接只能读取服务器列表。具体来说：
72+
1. 安装 MySQL，本文使用群晖的套件安装部署了 MySQL。
73+
2. 在 MySQL 中新建一个数据库，此处新建了一个叫做 `session_ai` 的数据库，这个数据库中不需要建立任何表。
74+
3. 在 MySQL 中新建一个账户 `session_admin`，并授予其 `session_ai` 数据库的所有权限。
75+
4. 在 1Remote `Setting` -> `Database` 选项卡页面的右上角，点击 `Add` 按钮，添加一个新的 MySQL 数据库。
76+
5. 回到 1Remote 主界面，点击右上角 `+` 按钮，向新添加的数据库中新增服务器配置。
77+
6. 在 MySQL 中新建一个账户 `session_user`，只授予其 `session_ai` 数据库的 `select` 权限，将这个用户发放给你的团队成员，他们用这个账户添加数据库后，将能够读取到 `session_ai` 数据库存储的服务器配置，但无法查看或修改它们的密码。
78+
7. Noted: 1Remote 通过定时查询来更新数据，所以当你修改服务器信息后，其他人可能需要等待几十秒的查询周期才能获取到最新的数据。
79+
80+
## 客制化
81+
82+
- 修改语言：`Setting` -> `General` -> `Language`
83+
- 修改主题：`Setting` -> `Theme` -> `Theme`，在这个页面你还可以定制自己喜欢的配色。
84+
- 修改SSH配色：`Setting` -> `Protocol` -> `SSH` -> `KiTTY` -> `Themes`

0 commit comments

Comments
 (0)