· 5 years ago · Jul 11, 2020, 06:16 AM
1# DO NOT USE NOTEPAD TO EDIT CONFIG FILES! USE NOTEPAD++ INSTEAD!
2# Uncomment a line when you want to change its default value (Remove # at the beginning)
3# When your configuration is done, rename this file by removing the ".example" extension
4# A different config-files can be included directly in processes by "--config-file" or "-cf" and path
5
6
7# Common settings
8#################
9
10location: 51.055,16.195 # Location, can be an address or coordinates.
11pogo-assets: PogoAssets # Directory pointing to optional PogoAssets root directory. (default=None)
12generate-images # Use ImageMagick to generate dynamic icons on demand.
13
14
15# Front end settings
16#################
17
18map-title: Pokemon Go Jawor # Title of the map. (default='RocketMAD')
19custom-favicon # Use a custom favicon. Generate your custom favicon files here: https://realfavicongenerator.net and place them in /static/images/appicons/custom.
20 # Set the path under Favicon Generator Options to '/static/images/appicons/custom'. (default=False)
21#no-header-image # Hides header image. (default=False)
22header-image: header.png # Image in header. Place image in 'static/images/header'. (default='rocket.png')
23#madmin-url: # MADmin URL e.g. http://127.0.0.1:5001/map (default=None)
24#donate-url: # Donation link, e.g. PayPal. (default=None)
25#patreon-url: # Patreon page link. (default=None)
26#discord-url: # Discord server invite link. (default=None)
27#messenger-url: # Messenger group invite link. (default=None)
28#telegram-url: # Telegram group invite link. (default=None)
29#whatsapp-url: # WhatsApp group invite link. (default=None)
30
31max-zoom-level: 10 # Maximum level a user can zoom out. Range: [0,18]. 0 means the user can zoom out completely. (default=10)
32cluster-zoom-level: 14 # Zoom level from which markers should be clustered. Range: [0,18]. -1 to disable clustering. (default=14)
33cluster-zoom-level-mobile: 14 # Zoom level from which markers should be clustered on mobile. Range: [0,18]. -1 to disable clustering on mobile. (default=14)
34max-cluster-radius: 14 # The maximum radius that a cluster will cover from the central marker (in pixels). (default=60)
35spiderfy-clusters: False # Spiderfy clusters at the bottom zoom level. (default=False)
36lock-start-marker # Disables dragging the start marker and hence disables changing the start position. (default=False)
37#no-geocoder # Do not add the geocoder (location search bar) to the map. (default=False)
38
39no-pokemon: False # Disables pokemon. (default=False)
40no-pokemon-values: False # Disables pokemon values. (ivs, cp, moves, etc.) (default=False)
41catch-rates: False # Show catch rates for all three balls. (default=False)
42#upscaled-pokemon: # Pokémon IDs to upscale icons for. Seperate IDs with commas. (default=None)
43no-pokemon-history-page: False # Disables pokemon history page. (default=False)
44verified-despawn-time # Show if pokemon despawn time is verified.
45show-all-zoom-level: 0 # Show all Pokemon, even excluded, at this map zoom level.
46 # Set to 0 to disable this feature. Set to 19 or higher for nice results.
47pokemon-cries: False # Play cries for pokemon notifications. Place your sound files (wav or mp3) in static/sounds/cries. (default=False)
48no-gyms: False # Disables gyms. (default=False)
49no-gym-sidebar: False # Disable the gym sidebar and toggle. (default=False)
50no-gym-filters: False # Disable gym filters in side nav. (default=False)
51no-raids: False # Disables raids. (default=False)
52no-raid-filters: False # Disable raid filters in side nav. (default=False)
53black-white-badges # Use black/white background with white/black text for gym/raid level badge in gym icons.
54
55no-pokestops: False # Disables pokestops. (default=False)
56no-quests: False # Disables quests. (default=False)
57quest-reset-time: 00:00 # Only show quests scanned after this time. (default=00:00)
58no-quest-page: False # Disables quest page. (default=False)
59no-invasions: False # Disables team rocket invasions. (default=False)
60no-lures: False # Disables lures. (default=False)
61
62#no-weather # Disables weather. (default=False)
63#no-spawnpoints # Disables spawn points. (default=False)
64#no-scanned-locs # Disables scanned locations. (default=False)
65#no-s2-cells # Disables s2 cells. (default=False)
66#no-ranges # Disables user to show interaction ranges. (default=False)
67
68
69no-stats-sidebar: False # Hides stats sidebar. (default=False)
70#twelve-hour-clock # Display time with the 12-hour clock format.
71#analytics-id: # Google Analytics Tracking-ID. (default=None)
72#map-update-interval: # Interval between raw-data requests (map updates) in milliseconds. (default=2500)
73
74
75
76
77
78
79
80#motd # Shows a MOTD (Message of the Day) on visit. (default=False)
81#motd-title: # MOTD title, can be HTML. (default='MOTD')
82#motd-text: # MOTD text, can be HTML. (default='Hi there! This is an easily customizable MOTD.')
83#motd-pages: # Pages the MOTD should be shown on. (default=['/', '/mobile'])
84#show-motd-always # Show MOTD on every visit. If disabled, the MOTD will only be shown when its title or text has changed. (default=False)
85
86
87# Database settings
88###################
89
90db-host: 127.0.0.1 # Required for mysql ()
91db-name: scan # Required for mysql
92db-user: user # Required for mysql
93db-pass: password # Required for mysql
94db-port: 3306 # Required for mysql (default=3306)
95db-pool-recycle: 7200 # Number of seconds after which a connection is automatically recycled. (default=7200)
96
97
98#Database cleanup
99#################
100# Database cleanup is done by running runhelper.py
101
102#db-cleanup-interval: # Time between database cleanups in seconds. Default: 600
103#db-cleanup-pokemon: # Clear pokemon from database X hours after they disappeared. Default: 0, 0 to disable.
104#db-cleanup-gym: # Clear gym details (including raids) from database X hours after last gym scan. Default: 0, 0 to disable.
105#db-cleanup-pokestop # Clear lure data, invasion data, and quests when no longer active. Default: False
106#db-cleanup-forts: # Clear gyms and pokestops from database X hours after last valid scan. Default: 0, 0 to disable.
107#db-cleanup-spawnpoint: # Clear spawnpoint from database X hours after last valid scan. Default: 0, 0 to disable.
108
109
110# Webserver settings
111####################
112
113host: 0.0.0.0 # Address to listen on (default='127.0.0.1')
114port: 5500 # Port to listen on (default=5000)
115#workers: # The number of worker processes for handling requests. Generally in the 2-4 x {NUM_CORES} range. (Default=2 x {NUM_CORES} + 1)
116#development-server # Use Flask’s built-in development server. Don't use this in production. (default=False)
117#locale: # Pokemon translation
118#cors # Enable CORS on web server.
119#ssl-certificate: # Path to ssl certificate
120#ssl-privatekey: # Path to ssl private key
121#encrypt-lib: # Path to encrypt lib to be used instead of the shipped ones.
122#trusted-proxies: # Enables the use of X-FORWARDED-FOR headers to identify the IP of clients connecting through these trusted proxies. (default=[])
123disable-blacklist # Disable the global anti-scraper IP blacklist.
124
125
126# Status and logs
127#################
128
129#status-name: # Enables writing status updates to the database - if you use multiple processes, each needs a unique value. (default=None)
130#access-logs # Write web logs to console and log file. (default=False)
131#no-file-logs # Disables logging to files except for access.log. (default=False)
132log-path: logs/ # Defines the path logs are saved at. (default=logs/)
133#log-filename: # Defines the log filename to be saved. The default generates yyyymmdd_HHMM_statusname.log. (default=%Y%m%d_%H%M_<SN>)
134#verbosity # Show debug messages from RocketMap and PGoApi. Values are 1,2,3 (default=0)
135
136
137# Dynamic rarity
138################
139# Updating dynamic rarity is done by running runhelper.py
140
141#rarity # Display Pokémon rarity. (default=False)
142#rarity-hours: # Number of hours of Pokémon data to use to calculate dynamic rarity, decimals allowed. 0 to use all data. (default=48.0)
143#rarity-update-frequency: # How often (in minutes) the dynamic rarity should be updated. decimals allowed. 0 to disable. (default=0)
144#rarity-filename: # Name of the JSON file (without .json) for dynamic rarity. Useful when running two or more instances out of the same folder. (default='rarity')
145
146
147# Parks
148#######
149# Download ex raid eligible and nest parks from the Overpass API. Parks are saved to `static/data/parks/{file_name}.json`.
150# Remove the JSON file(s) to redownload the parks. Park downloading is done by running runhelper.py
151
152#ex-parks # Display ex raid eligible parks. (default=False)
153#nest-parks # Display nest parks. (default=False)
154#ex-parks-downloading # Enables ex raid eligible parks downloading. (default=False)
155#nest-parks-downloading # Enables nest parks downloading. (default=False)
156#ex-parks-geofence-file: # Geofence file to define outer borders of the ex park area to download.
157#nest-parks-geofence-file: # Geofence file to define outer borders of the nest park area to download.
158#ex-parks-filename: # Name of the JSON file (without .json) for ex parks. Useful when running two or more instances out of the same folder. (default='parks-ex')
159#nest-parks-filename: # Name of the JSON file (without .json) for nest parks. Useful when running two or more instances out of the same folder. (default='parks-nest')
160#parks-query-timeout: # The maximum allowed runtime for the parks query in seconds. (default=86400)
161
162
163# User authentication
164####################
165
166#server-uri: # URI of your website/server. Authentication apps will use this to redirect the user to.
167#secret-key: # Key used to sign sessions. Must be at least 16 characters long.
168redis-host: 127.0.0.1 # Address of Redis server (Redis is used to store session data). (default='127.0.0.1')
169redis-port: 6379 # Port of Redis server. (default=6379)
170login-required: False # If enabled, user must be logged in with any auth system before one can access the map. (default=False)
171no-multiple-logins: False # Do not allow more than one login per account. (default=False)
172
173
174# Discord authentication
175####################
176# If you want users to auth to Discord prior to accessing server, enable discord-auth, create an app here:
177# https://discordapp.com/developers/applications/me and add a redirect uri to your the application in this format: https://mysrv.com/auth/discord
178# To require a user to be in one of your guilds (servers) to gain access, specify the required guild ids and an invite url to send them to if
179# they are not in any of the required guilds.
180# To require a user be in specific roles in the guild to gain access, add a bot to the application at the above developer application page,
181# then add that bot to your guild (server) using this link: https://discordapp.com/api/oauth2/authorize?client_id=YOUR_CLIENT_ID&scope=bot
182
183discord-auth: False # Authenticate users with Discord OAuth2. (default=False)
184#discord-client-id: # OAuth2 client ID.
185#discord-client-secret: # OAuth2 client secret.
186#discord-bot-token: # Token for bot with access to your guild. Only required for required/blaclisted roles feature.
187#discord-blacklisted-users: # List of user ID's that are always blocked from accessing the map. (default=[])
188#discord-whitelisted-users: # List of user ID's that are always allowed to access the map. (default=[])
189#discord-required-guilds: # If guild ID(s) are specified, user must be in at least one discord guild (server) to access map. Comma separated list if multiple. (default=[])
190#discord-blacklisted-guilds: # If guild ID(s) are specified, user must NOT be in any of these guilds (servers) to access map. Comma separated list if multiple. (default=[])
191#discord-required-roles: # If specified, user must have one of these discord roles (from a specific guild) to access map.
192 # Accepts list of role IDs, or list of guild IDs and roles IDs separated by ':'. Example: [<guild1>:<role1>, <guild2>:<role2>]. (default=[])
193#discord-blacklisted-roles: # If specified, user must NOT have any of these discord roles (from a specific guild) to access map. (default=[])
194#discord-no-permission-redirect: # Link to redirect user to if user has no permission. Typically this would be your discord guild invite link.
195#discord-access-configs: # Use different config file based on discord role (or guild). Accepts list with elements in this format: <guild_id>:<role_id>:<access_config_name>
196 # You can also only use guilds. If multiple config files correspond to one user, only the first file is used. (default=[])
197#discord-admins: # Discord users that have admin rights. Accepts list of Discord user IDs. (default=[])
198
199
200# Telegram authentication
201####################
202# If you want to authenticate users with Telegram, first create a bot with @Botfather.
203# Next find your bot token with @Botfather (/mybots -> API Token). With @Botfather set the Domain to your map URL (/mybots -> Bot Settings -> Domain).
204# You can retrieve chat and member IDs like this: https://api.telegram.org/bot<your_bot_token>/getUpdates
205
206#telegram-auth # Authenticate users with telegram. (default=False)
207#telegram-bot-token: # Telegram bot token.
208#telegram-bot-username: # Telegram bot username (without @).
209#telegram-blacklisted-users: # List of user ID's that are always blocked from accessing the map. (default=[])
210#telegram-required-chats: # If chat ID(s) are specified, user must be in at least one telegram group chat to access map. Comma separated list if multiple. (default=[])
211#telegram-no-permission-redirect: # Link to redirect user to if user has no permission. Typically this would be your telegram group chat invite link.
212#telegram-access-configs: # Use different config file based on telegram chat. Accepts list with elements in this format: <chat_id>:<access_config_name>
213 # If multiple config files correspond to one user, only the first file is used. (default=[])
214#telegram-admins: # Telegram users that have admin rights. Accepts list of Telegram user IDs. (default=[])
215
216
217# Misc
218######
219
220#dump # Dump censored debug info about the environment and auto-upload to hastebin.com.