-
Notifications
You must be signed in to change notification settings - Fork 28
Merge main into client #444
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
1465814
Fix dedicated field on places
Heliodex 880d0b9
Launcher configuration and building instructions details, more inform…
Heliodex 35987fb
Change characterfetch to use insecure domain in charapps
Heliodex d2a2b63
Update dependencies
Heliodex 6ff9130
File formatting
Heliodex e440f94
Basic launcher setup page, add .NET SDK to tool installation list
Heliodex 6ae0f1d
Move launchersetup to mdoc to allow better steps formatting
Heliodex bf98eda
Add closing tag for steps block in launcher setup guide
Heliodex b820f74
Update information on removal of certain Corescripts in example repos…
Heliodex da0860e
Add .NET SDK installation guide and references in docs
Heliodex f1f4d58
Link automatic installation to relevant issue (#352)
Heliodex 641a0b8
Create RCCService setup guide, some more RCC information
Heliodex ec9dfec
Add instructions to the RCC setup guide
Heliodex 3a7173a
Update listed dependency & tool versions
Heliodex 3462fef
Update docs dependencies
Heliodex b4483fa
Improve docs package.json scripts
Heliodex 514ee55
Add secure option to email configuration and transport setup
Heliodex 5fc9792
Await email sending to allow for completion before redirect
Heliodex File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| title: Launcher setup | ||
| description: How to set up the Launcher, the application responsible for starting and handling Client sessions, for local development and production hosting. | ||
| --- | ||
|
|
||
| This guide details how to set up the Mercury Launcher for local development, moderation, and production publishing. More information on the Launcher is available on the [Launcher service page](/services/launcher). | ||
|
|
||
| ## Requirements | ||
|
|
||
| You will need: | ||
|
|
||
| - Latest version of [Git](https://git-scm.com) installed (expected as `git`, optional) | ||
| - Latest version of the [.NET SDK](https://dotnet.microsoft.com) installed (expected as `dotnet`, [installation guide](/install/dotnet)) | ||
| - A terminal | ||
|
|
||
| ## Instructions | ||
|
|
||
| {% steps %} | ||
|
|
||
| 1. Clone the [tp-link-extender/MercuryLauncher](https://github.com/tp-link-extender/MercuryLauncher) repository to a directory of your choice on your local machine, and navigate to the root directory of the repository. | ||
|
|
||
| ```bash | ||
| git clone https://github.com/tp-link-extender/MercuryLauncher | ||
| cd MercuryLauncher | ||
| ``` | ||
|
|
||
| - If not using Git, you can also [download the repository as a compressed archive file](https://github.com/tp-link-extender/MercuryLauncher/archive/refs/heads/main.zip) (.zip) from the GitHub page and extract it to a directory of your choice. | ||
|
|
||
| 2. Navigate to the **Config.fs** file and modify the configuration options as desired. See the [Launcher service page](/services/launcher#configuration) for more information on the available configuration options. | ||
|
|
||
| 3. Run `dotnet run` to test the Launcher. If everything is set up correctly, the Launcher will start building. Once it is complete, it will start, immediately attempting to install the latest Setup deployment from the configured URL. It will not attempt to start the Client or Studio. | ||
|
|
||
| - If this command is being run for the first time, a welcome message similar to the following will be printed to the console: | ||
|
|
||
| ``` | ||
| Welcome to .NET 10.0! | ||
| --------------------- | ||
| SDK Version: 10.0.200 | ||
|
|
||
| Telemetry | ||
| Read more about .NET CLI Tools telemetry: https://aka.ms/dotnet-cli-telemetry | ||
|
|
||
| ---------------- | ||
| Installed an ASP.NET Core HTTPS development certificate. | ||
| To trust the certificate, run 'dotnet dev-certs https --trust' | ||
| Learn about HTTPS: https://aka.ms/dotnet-https | ||
|
|
||
| ---------------- | ||
| Write your first app: https://aka.ms/dotnet-hello-world | ||
| Find out what's new: https://aka.ms/dotnet-whats-new | ||
| Explore documentation: https://aka.ms/dotnet-docs | ||
| Report issues and find source on GitHub: https://github.com/dotnet/core | ||
| Use 'dotnet --help' to see available commands or visit: https://aka.ms/dotnet-cli | ||
| -------------------------------------------------------------------------------------- | ||
| ``` | ||
|
|
||
| 4. After you have modified the source code as required and are ready to publish the launcher, run the corresponding command for the operating system you wish to publish for: | ||
|
|
||
| - Windows: `dotnet publish --nologo -o ./out -r win-x64` | ||
| - Linux: `dotnet publish --nologo -o ./out -r linux-x64` | ||
|
|
||
| These commands will each place the published executable in the **out** directory. | ||
|
|
||
| {% /steps %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: RCCService setup | ||
| description: How to set up RCCService, used for rendering images on the Site, as well as its associated proxy, for local development and production hosting. | ||
| --- | ||
|
|
||
| This guide details how to set up RCCService for local development, moderation, and production publishing. More information, including general details on how RCC works, is available on the [RCCService service page](/services/rccservice). | ||
|
|
||
| For the purposes of this guide, a [proxy server](/services/rccservice#proxying) will be used to start and manage the RCC process and all communications with it. This is the recommended setup for both development and production. | ||
|
|
||
| ## Requirements | ||
|
|
||
| You will need: | ||
|
|
||
| - Latest version of [Git](https://git-scm.com) installed (expected as `git`, optional) | ||
| - Latest version of [Go](https://go.dev) installed (expected as `go`, [installation guide](/install/go)) | ||
| - A terminal | ||
|
|
||
| ## Instructions | ||
|
|
||
| {% steps %} | ||
|
|
||
| 1. Clone the [tp-link-extender/RCCService](https://github.com/tp-link-extender/RCCService) repository to a directory of your choice on your local machine, and navigate to the root directory of the repository. | ||
|
|
||
| ```bash | ||
| git clone https://github.com/tp-link-extender/RCCService | ||
| cd RCCService | ||
| ``` | ||
|
|
||
| - If not using Git, you can also [download the repository as a compressed archive file](https://github.com/tp-link-extender/RCCService/archive/refs/heads/main.zip) (.zip) from the GitHub page and extract it to a directory of your choice. | ||
|
|
||
| 2. Navigate to the **Proxy** directory. Copy the **Proxy/.env.example** file to **Proxy/.env** and modify it to set up the environment variables. | ||
|
|
||
| 3. Run `go build` to compile the proxy server. This will produce an executable file in the same directory, either **Proxy.exe** on Windows or **Proxy** on Linux. | ||
|
|
||
| 4. Copy both the compiled proxy executable and the **Proxy/.env** file to their parent directory, the root of the repository. The proxy executable needs to be in the same directory as the **RCCService** folder to be able to start the RCC process correctly, and the **.env** file needs to be in the same directory as the proxy executable for the proxy to read its configuration. | ||
|
|
||
| 5. Run the proxy executable to start the proxy server and the RCC process. The proxy will automatically restart the RCC process if it crashes or is killed, and will print logs from both itself and the RCC process to the console. | ||
|
|
||
| {% /steps %} | ||
|
|
||
| If you're using RCC with Mercury Core, make sure to check its configuration to ensure that the [RCCServiceProxyURL](/guides/config#rccserviceproxyurl) property is set to the correct URL of your proxy server, including the appropriate scheme and port. The default value should work correctly if the proxy server is running on the same machine as the Site. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| title: .NET SDK | ||
| description: Details on how to install the .NET SDK. | ||
| --- | ||
|
|
||
| [.NET](https://dotnet.microsoft.com) is a software framework used for building and running applications, working on multiple desktop platforms. The .NET SDK (Software Development Kit) includes the tools and libraries needed to develop .NET applications. At the time of writing, the latest version is [**v10.0.200**](https://dotnet.microsoft.com/en-us/download/dotnet/10.0). | ||
|
|
||
| Check out the [installation guide](https://learn.microsoft.com/dotnet/core/install/) for detailed instructions. Alternatively, it may be possible to install the .NET SDK using a package manager of your choice. | ||
|
|
||
| After installation, the .NET SDK should be available from the command line with `dotnet`. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a leading space at the beginning of line 6. The paragraph starts with
[.NET]instead of[.NET].