Skip to content

Commit aea7d14

Browse files
committed
Add Configuration documentation
1 parent a6dccf4 commit aea7d14

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,42 @@ Archiver dialogs and messages of Telegram (http://telegram.org)
55
This project is based on TLSharp (https://github.com/sochix/TLSharp)
66

77
![Screenshot](Screenshot.bmp)
8+
9+
### Configuration
10+
11+
Create the configuration file `App.config` from the template [App.config.tpl](https://github.com/Starli0n/TLArchiver/blob/master/TLArchiver/App.config.tpl)
12+
13+
The proxy settings are defined by the parameters:
14+
* `HttpProxyHost` (192.168.x.x)
15+
* `HttpProxyPort` (80)
16+
* `ProxyUserName` (username)
17+
* `ProxyPassword` (password)
18+
19+
To obtain your own API id, follow the guidelines of [Telegram](https://core.telegram.org/api/obtaining_api_id)
20+
* `ApiHash`
21+
* `ApiId`
22+
* `SignInPhoneNumberCode` (`+33` for France)
23+
* `SignInPhoneNumber` (`06xxxxxxxx`)
24+
Therefore, the number used for the connection would be `+336xxxxxxxx` = `SignInPhoneNumberCode` + `SignInPhoneNumber` without the first `0`.
25+
26+
Enter the code you receive by phone into the GUI and then click on `Login`.
27+
Therefore let `CodeToAuthenticate` empty.
28+
29+
Set the output directory for the export `ExportDirectory`.
30+
In `Debug`, this parameter is bypassed by the debug configuration [App.Debug.config](https://github.com/Starli0n/TLArchiver/blob/master/TLArchiver/App.Debug.config)
31+
32+
Set the limit of messages while requesting the server.
33+
Messages of a dialog are read by packet of `MessagesReadLimit`.
34+
35+
If you want the app to count the messages of all dialogs during the initialisation step, set `CountMessagesAtLaunch` to true.
36+
However, it will slow down the start.
37+
38+
The configuration is mainly based on the one defined by the [TLSharp](https://github.com/sochix/TLSharp/blob/master/TLSharp.Tests/app.config) library.
39+
Some parameters are not used in the project, so let them empty:
40+
* `NotRegisteredNumberToSignUp`
41+
* `NumberToSendMessage`
42+
* `UserNameToSendMessage`
43+
* `NumberToGetUserFull`
44+
* `NumberToAddToChat`
45+
46+
Note: `NumberToSendMessage` and `UserNameToSendMessage` are used whenever you want to send message with `TLSharp`.

0 commit comments

Comments
 (0)