From fa77399e24d88766eef392577e361119ca68a9c5 Mon Sep 17 00:00:00 2001 From: lingxiaoyiyu-hub Date: Thu, 18 Jun 2026 07:23:28 +0800 Subject: [PATCH] docs: fix typos in README.md - Fix 'exmaple' -> 'example' in CORS example URL - Fix 'appsetttings.json' -> 'appsettings.json' in Logging section --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 71107ebc1..16ae022fa 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,7 @@ You can change database by changing `DBProvider` in `ApplicationOptions` to `SQL - In IIS, this can be done in the web.config file by setting stdoutLogEnabled to true. - On Windows Servers, the above logs can also be written to the Windows Event Log. - This is enabled in Server Config by setting EnableWindowsEventLog to true. -- You can configure logging levels and other settings in appsetttings.json. +- You can configure logging levels and other settings in appsettings.json. - More information: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/ ## Remote Control Client Requirements @@ -193,7 +193,7 @@ The host port (left side) can be configured in `docker-compose.yml`. The contai Remotely has a basic API, which can be browsed at `https://{your_server_url}/swagger`. Most endpoints require authentication via an API access token, which can be created by going to Account - API Access. -When accessing the API from the browser on another website, you'll need to set up CORS in appsettings by adding the website origin URL to the TrustedCorsOrigins array. If you're not familiar with how CORS works, I recommend reading up on it before proceeding. For example, if I wanted to create a login form on https://exmaple.com that logged into the Remotely API, I'd need to add "https://example.com" to the TrustedCorsOrigins. +When accessing the API from the browser on another website, you'll need to set up CORS in appsettings by adding the website origin URL to the TrustedCorsOrigins array. If you're not familiar with how CORS works, I recommend reading up on it before proceeding. For example, if I wanted to create a login form on https://example.com that logged into the Remotely API, I'd need to add "https://example.com" to the TrustedCorsOrigins. Each request to the API must have a header named "X-Api-Key". The value should be the API key's ID and secret, separated by a colon (i.e. [ApiKey]:[ApiSecret]).