Created settings.general (markdown)

2018-12-04 23:15:20 +09:00 · 2018-12-04 23:15:20 +09:00 · e1b85c0d80
parent 51c2a98f42
commit e1b85c0d80
1 changed files with 193 additions and 0 deletions
--- a/settings.general.md
+++ b/settings.general.md
@ -0,0 +1,193 @@
+This is a description of the general settings of the Profit Trailer Magic application. A guide for editing JSON files can be found [here](https://github.com/Legedric/ptmagic/wiki/Editing-JSON-files).
+
+# Application
+### IsEnabled
+Enables the application in general.
+
+`Default: true`  
+`Expected values: true, false`
+
+### TestMode
+Enables the test mode of PT Magic. When TestMode is enabled, no Profit Trailer files will be changed.
+
+`Default: true`  
+`Expected values: true, false`
+
+### ProfitTrailerMajorVersion
+Major version of your Profit Trailer bot
+(If you are using 1.2.x the major version is "1", if you are using 2.x the major version is "2" and so on)
+
+`Default: 1`  
+`Expected values: 1, 2, 3 etc.`
+
+### ProfitTrailerPath
+Absolute filepath to the Profit Trailer root directory.
+
+### ProfitTrailerLicense
+Your Profit Trailer license key
+(needed to change your settings for PT 2.0 and above)
+
+### ProfitTrailerMonitorURL
+The URL to your profit trailer monitor
+(needed to change your settings for PT 2.0 and above)
+
+`Default: http://localhost:8080/`  
+
+### ProfitTrailerDefaultSettingName
+Your Profit Trailer default setting name
+(needed to change your settings for PT 2.0 and above)
+
+`Default: default`  
+
+### Exchange
+The exchange you are running your Profit Trailer on.
+
+`Expected values: Bittrex, Binance, Poloniex`
+
+### StartBalance
+The balance you had in your wallet when you started working with Profit Trailer
+
+`Expected values: Float`
+
+### TimezoneOffset
+Your timezone offset from UTC time
+
+`Expected values: Strings in format "+1:00" or "-7:00" etc.`
+
+### MainFiatCurrency
+Your main fiat currency that will be used in the monitor
+
+`Expected values: Valid currencies from this list:` http://api.fixer.io/latest?base=USD
+
+### AlwaysLoadDefaultBeforeSwitch
+When this is activated, PT Magic will always reload "Default" settings whenever it switches to another setting. This may be helpful if you are mostly using offset values, to ensure that the offset is taking the default value and not an already adjusted value.
+
+`Default: true`  
+`Expected values: true, false`
+
+### FloodProtectionMinutes
+Number of minutes to wait before switching the global settings after they have been changed. If a price trend is just zig-zagging around its trigger, you may want to protect your settings from getting switched back and forth every time the analyzer runs. (see [IntervalMinutes](https://github.com/Legedric/ptmagic/wiki/settings.analyzer#intervalminutes))
+
+`Default: 15`  
+`Expected values: Integer`
+
+### CoinMarketCapAPIKey
+If you wish to use CoinMarketCap market data, you will need to enter your CoinMarketCap account API here. (see [2.0.5 Patch details](https://github.com/Legedric/ptmagic/releases/tag/2.0.5)) for more information.
+
+`Default: ""`  
+`Expected values: String`
+
+# Monitor
+### IsPasswordProtected
+Defines if you monitor website will be protected by a password or not.
+
+`Default: true`  
+`Expected values: true, false`
+
+### OpenBrowserOnStart
+If this is active, a browser window pointing to the monitor will open when the monitor app gets started
+
+`Default: false`  
+`Expected values: true, false`
+
+### Port
+The port to run your monitor on.
+
+`Default: 5000`  
+`Expected values: Integer`
+
+### GraphIntervalMinutes
+The interval for the monitor market trend graph to draw points.
+
+`Default: 60`  
+`Expected values: Integer`
+
+### GraphMaxTimeframeHours
+This will enable you to define the timeframe that your graph for market trends covers.
+
+`Default: 24`  
+`Expected values: Integer`
+
+### RefreshSeconds
+The refresh interval of your monitor main page.
+
+`Default: 30`  
+`Expected values: Integer`
+
+### LinkPlatform
+The platform to which the pair name will link if you click on it.
+
+`Default: TradingView`  
+`Expected values: TradingView, Exchange`
+
+### DefaultDCAMode
+The default mode of the DCA calculator to be used when you access it using your monitor.
+
+`Default: Simple`  
+`Expected values: Simple, Advanced`
+
+### MaxTopMarkets
+The amount of top markets being shown in your Sales Analyzer
+
+`Default: 20`  
+`Expected values: Integer`
+
+### MaxDailySummaries
+The amount of "Last Days" being shown in your Sales Analyzer
+
+`Default: 10`  
+`Expected values: Integer`
+
+### MaxMonthlySummaries
+The amount of "Last Months" being shown in your Sales Analyzer
+
+`Default: 10`  
+`Expected values: Integer`
+
+### MaxDashboardBuyEntries
+The amount of possible buy entries being shown in your dashboard
+
+`Default: 10`  
+`Expected values: Integer`
+
+### MaxDashboardBagEntries
+The amount of pairs/dca entries being shown in your dashboard
+
+`Default: 10`  
+`Expected values: Integer`
+
+# Backup
+### IsEnabled
+Enables a backup procedure for your properties files. Before every switch PT Magic will backup the current properties.
+
+`Default: true`  
+`Expected values: true, false`
+
+### MaxHours
+Max number of hours to keep backup files
+
+`Default: 48`  
+`Expected values: Integer`
+
+# Telegram
+### IsEnabled
+Enables PT Magic to send Telegram messages
+
+`Default: false`  
+`Expected values: true, false`
+
+### BotToken
+Your Telegram bot token
+
+`Expected values: String`
+
+### ChatId
+Your Telegram Chat ID
+
+`Expected values: Integer`
+
+### SilentMode
+If SilentMode is active, no notification sound or vibration will happen when the bot sends a Telegram message
+
+`Default: false`  
+`Expected values: true, false`