You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-137Lines changed: 9 additions & 137 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,36 +39,17 @@ The project was renamed to Arcane to avoid the generic nature of the previous na
39
39
40
40
## Version Table
41
41
42
-
> ⓘ You can use any version of the viewer with any version of the server, as long as the protocol version matches. The protocol version ensures compatibility between the viewer and the server.
43
-
44
-
> ⓘ It is recommended to always use the latest versions of both the viewer and the server whenever possible. This ensures compatibility between the two and provides the best experience.
| 1.0.5b | 5.0.1 | 22 August 2024 |[1.0.4](https://github.com/PhrozenIO/ArcaneServer/releases/tag/1-0-4)|
66
47
67
-
> ⓘ Since version 1.0.4, the server version will only be updated when there are changes to the server code. It will no longer automatically reflect the latest viewer version as it did before.
48
+
> ⓘ You can use any version of the viewer with any version of the server, as long as the protocol version matches. The protocol version ensures compatibility between the viewer and the server.
68
49
69
-
## Components
50
+
> ⓘ It is recommended to always use the latest versions of both the viewer and the server whenever possible. This ensures compatibility between the two and provides the best experience.
70
51
71
-
### Arcane Viewer
52
+
##Quick Setup ([PyPi.org](https://pypi.org))
72
53
73
54
The recommended way to install and launch the Arcane viewer is to first create a virtual environment. This can be done using **virtualenv** as follows:
74
55
@@ -98,118 +79,9 @@ arcane-viewer
98
79
99
80
### Arcane Server
100
81
101
-
#### Fast Use
102
-
103
-
The easiest way to install and run the server is by installing the PowerShell module from the PowerShell Gallery:
104
-
105
-
> Please note that you must have administrative privileges to install a new module. To do this, open an elevated PowerShell prompt and execute the following command:
106
-
107
-
```powershell
108
-
Install-Module -Name Arcane_Server
109
-
```
110
-
111
-
Before running the server, you must import the module into your PowerShell session:
112
-
113
-
> Please note that depending on your system configuration, you may need to run the following command to temporarily bypass the execution policy in order to run an unsigned script:
114
-
> `powershell.exe -executionpolicy bypass`
115
-
116
-
```powershell
117
-
Import-Module Arcane_Server
118
-
```
119
-
120
-
Once the module is installed, you can run the server using the following command:
| ServerAddress | String | 0.0.0.0 | IP address representing the local machine's IP address |
139
-
| ServerPort | Integer | 2801 | The port number on which to listen for incoming connections |
140
-
| SecurePassword | SecureString | None | SecureString object containing the password used for authenticating remote viewers (recommended) |
141
-
| Password | String | None | Plain-text password used for authenticating remote viewers (not recommended; use SecurePassword instead) |
142
-
| DisableVerbosity | Switch | False | If specified, the program will suppress verbosity messages |
143
-
| UseTLSv1_3 | Switch | False | If specified, the program will use TLS v1.3 instead of TLS v1.2 for encryption (recommended if both systems support it) |
144
-
| Clipboard | Enum | Both | Specify the clipboard synchronization mode (options include 'Both', 'Disabled', 'Send', and 'Receive'; see below for more detail) |
145
-
| CertificateFile | String | None | A file containing valid certificate information (x509) that includes the private key |
146
-
| EncodedCertificate | String | None | A base64-encoded representation of the entire certificate file, including the private key |
147
-
| ViewOnly | Switch | False | If specified, the remote viewer will only be able to view the desktop and will not have access to the mouse or keyboard |
148
-
| PreventComputerToSleep | Switch | False | If specified, this option will prevent the computer from entering sleep mode while the server is active and waiting for new connections |
149
-
| CertificatePassword | SecureString | None | Specify the password used to access a password-protected x509 certificate provided by the user |
| Disabled | Clipboard synchronization is disabled on both the viewer and server sides |
163
-
| Receive | Only incoming clipboard data is allowed |
164
-
| Send | Only outgoing clipboard data is allowed |
165
-
| Both | Clipboard synchronization is allowed on both the viewer and server sides |
166
-
167
-
##### ⚠️ Important Notices
168
-
169
-
1. It is recommended to use SecurePassword instead of a plain-text password, even if the plain-text password is being converted to a SecureString.
170
-
2. If you do not specify a custom certificate using 'CertificateFile' or 'EncodedCertificate', a default self-signed certificate will be generated and installed for the local user.
171
-
3. If you do not specify a SecurePassword or Password, a random, complex password will be generated and displayed in the terminal (this password is temporary).
You can then pass the output base64 certificate file to parameter `EncodedCertificate` (One line)
82
+
For detailed instructions on how to use and configure the Arcane Server, please refer to the [official Arcane Server repository](https://github.com/PhrozenIO/ArcaneServer). The repository contains comprehensive documentation, including setup guides, configuration options, and best practices for managing your server effectively.
0 commit comments