Merge branch 'main' of https://github.com/Arcaea-Infinity/ArcaeaUnlim…

…itedAPI-Wiki
Arcaea-Infinity · Apr 13, 2023 · 18a5ce9 · 18a5ce9
2 parents 281aef2 + a5f20f5
commit 18a5ce9
Showing 1 changed file with 11 additions and 15 deletions.
diff --git a/deploy.md b/deploy.md
@@ -2,39 +2,35 @@
 
 ### Get Started
 
-* install ASP.NET Core Runtime 6.0
-* download the latest release
-* edit configuration files
-* download arcsong.db to data_path then override the empty one
-* add some arcaea accounts (name & password) in arcaccount.db
-* (optional) add some nodes
-* start service
+* Install ASP.NET Core Runtime 6.0
+* Download the latest release
+* Start service
+* Follow the prompts to proceed after filling in the `challenge_token`, saving and restarting the service
 
 ### Configuration fields
 
 * config.json
 
   | field           | description                                                   | example                                   |
   |:----------------|:--------------------------------------------------------------|-------------------------------------------|
-  | data_path       | path to save files and databases                              | "/etc/arcaeaunlimitedapi/data"            |
-  | app_version     | latest Arcaea version                                         | "3.12.8c"                                 |
-  | api_entry       | latest Arcaea API entry                                       | "years/19"                                |
+  | api_entry       | latest Arcaea API entry                                       | "join/21"                                 |
+  | app_version     | latest Arcaea version                                         | "4.3.2c"                                  |  
   | host            | latest Arcaea API Host                                        | "arcapi-v2.lowiro.com"                    |
-  | cert_name       | certificate file name in the data folder                      | "cert-3.12.8c.p12"                        |
+  | cert_name       | certificate file name in the data folder                      | "cert-4.3.2c.p12"                         |
   | cert_password   | certificate file password                                     | "HelloWorld"                              |
+  | data_path       | path to save files and databases                              | "/etc/arcaeaunlimitedapi/data"            |
   | open_register   | whether to register accounts automaticly                      | false                                     |
   | auto_update     | whether to update assets automaticly                          | false                                     |
   | quota           | Allow the number of requests without token per ip per day     | 0                                         |
+  | challenge_type  | the type of the challenge API                                 | "aua" <br/> "taikari"                     |  
   | challenge_api   | the url of the challenge API                                  | "https://example.com/botarcapi/challenge" |
-  | challenge_type  | the type of the challenge API                                 | "aua" <br/> "taikari"                     |
   | challenge_token | the token of the challenge API (Taikari API will ignore this) | "yourtokenhere"                           |
   | nodes           | TCP port forwarding server                                    |                                           |
 
-* useragents.json
-  *  whitelist of User-Agent in regex array like `[".*"]`
+> Note: most of fields in `config.json` is not need to fill in manually after the first-start
 
 * tokens.json
-  *  whitelist of Bearer Token in array
+  *  whitelist array of token(string) in json format
 
 * appsettings.json