diff --git a/Setup-Guide.md b/Setup-Guide.md new file mode 100644 index 0000000..9010682 --- /dev/null +++ b/Setup-Guide.md @@ -0,0 +1,60 @@ +1. Follow the instructions ofr your operating system ([Windows](https://github.com/Legedric/ptmagic/wiki/Setup-PT-Magic-on-Windows), [Linux](https://github.com/Legedric/ptmagic/wiki/Setup-PT-Magic-on-Linux), [MacOS](https://github.com/Legedric/ptmagic/wiki/Setup-PT-Magic-on-MacOS)) + +2. **Download** and extract the latest release (ZIP) of PT Magic: + + https://github.com/Legedric/ptmagic/releases + +3. **Unpack** the ZIP file to a location you want to use for PT Magic + +4. **Copy** all files and the folder "Monitor" located in "_default settings (YOUT PT VERSION)/_default settings (YOUR TRADING CURRENCY)" to "PTMagic" +_Hint:_ Only copy the files that are meant for your trading currency! Not both folders! + +5. **Profit Trailer 1.x** (skip this if you are using PT 2.x) + **Copy** your PAIRS.PROPERTIES, DCA.PROPERTIES and INDICATORS.PROPERTIES from your Profit Trailer "trading" directory to "_presets/Default/" in "PTMagic" + _Hint:_ This will take your personal Profit Trailer settings as default settings for PT Magic. + +6. **Profit Trailer 2.x** (skip this if you are using PT 1.x) +- Create 3 new (empty) files in the folder "_presets/Default" named PAIRS.properties, DCA.properties and INDICATORS.properties +- Go to your Profit Trailer monitor in your browser +- Navigate to Config -> PAIRS +- Copy the entite settings text over to the newly created (empty) PAIRS.properties and save the file +- Repeat this step for DCA and INDICATORS.properties files + _Hint:_ This will take your personal Profit Trailer settings as default settings for PT Magic. + +7. **Open** Your "application.properties" file of Profit Trailer and change the variable **trading.logHistory** to something high like _9999_. + _Hint:_ This will make sure that Profit Trailer keeps your sales log entries for nearly forever and you keep your sales statistics. + +8. **Open** "settings.general.json" with a text editor and adjust the settings to your needs + _Hint:_ Double check the setting for "**ProfitTrailerPath**" and "**Exchange**" as if they are not correct, you will run into issues. + + **Example:** + ![](http://profit-trailer-magic.com/wiki/Setup/PTMSettings.general.PNG) + + **Important:** Please check that you used _**DOUBLE**_ backslashes in the Path, not SINGLE backslashes. Otherwise you get the follwing error: + + `FATAL - Error loading configuration! System.FormatException Could not parse the JSON file` + +9. **Open** "settings.analyzer.json" with a text editor and adjust the settings to your needs + +10. **Open** "Monitor/appsettings.json" with a text editor and adjust the PTMagicBasePath to your PT Magic root directory. + _Hint:_ This is necessary for the monitor to get the data from the PT Magic bot. + + **Important:** Please check that you used _**DOUBLE**_ backslashes in the Path, not SINGLE backslashes. Otherwise you get the follwing error: + + `FATAL - Error loading configuration! System.FormatException Could not parse the JSON file` + + **Example:** + ![](http://profit-trailer-magic.com/wiki/Setup/PTMapplication.settings.PNG) + +11. **Run** "Start PTMagic.cmd" and wait for it to complete its first run + **_Important:_** When you start PT Magic for the very first time it may take **up to 15 minutes** for it to grab all the necessary data from your exchange. After this first run it will only take a couple of seconds for each run to complete. + +12. **Run** "Start PTMagic Monitor.cmd" to start the monitoring service + **_Important:_** After you start the Monitor service, keep the window open. This is basically the web server that provides the monitoring service. You may minimize it of course, but do not close it or you will no longer able to access the monitor. + + ![](https://i.imgur.com/E0o5GEK.png) + +13. **Navigate** to http://localhost:5000 **on the same machine/server** to open the monitor + _Hint:_ Change the 5000 to the port you specified in your "settings.general.json" file. 5000 is the default port for the PT Magic monitor. + +14. If something is not working as expected please have a look at our [Post Install Checklist](https://github.com/Legedric/ptmagic/wiki/Post-Install-Checklist) and [FAQ](https://github.com/Legedric/ptmagic/wiki/FAQ-and-Tips). \ No newline at end of file