forked from inex/IXP-Manager
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.env.example
311 lines (221 loc) · 10.2 KB
/
.env.example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
#######################################################################################
#
# IXP Manager V4+ configuration.
#
#
# Run "artisan key:generate" to set the application key:
APP_KEY=
# Set this to false in production (but change it to true if you have installation or
# other issues running IXP Manager).
APP_DEBUG=false
# Web address where IXP Manager is accessed. This is a **required** setting. It is
# currently used for generating all URLs within IXP Manager (action, assets, etc.).
# It is also used / required for sending emails via CLI scripts.
#
APP_URL="https://ixp.example.com"
# See http://php.net/manual/en/timezones.php for a list of timezones:
APP_TIMEZONE="UTC"
# Laravel log format (storage/log). See config/log.php and
# https://laravel.com/docs/5.4/errors
APP_LOG="single"
# info by default, one of: debug, info, notice, warning, error, critical, alert, emergency.
APP_LOG_LEVEL=debug
TELESCOPE_ENABLED=false
# MySQL Connection Details
DB_HOST="127.0.0.1"
DB_DATABASE="ixp"
DB_USERNAME="ixp"
DB_PASSWORD="password"
#######################################################################################
### Email Settings.
#
# We use Laravel's mail system - see: https://docs.ixpmanager.org/usage/email/
#
# The default setting are as follows:
#
# MAIL_MAILER="smtp"
# MAIL_HOST="localhost"
# MAIL_PORT=25
# MAIL_ENCRYPTION=false
#######################################################################################
### Identity
#
# Used throughout IXP Manager in various ways.
#
# This has grown organically and we intend to clean this up in a coming release and
# documenting where and how each one is spceifically used.
# Used in various emails, etc.
IDENTITY_SITENAME="Vagrant IXP Manager"
APP_NAME="${IDENTITY_SITENAME}"
# Shown in title bar of web portal. Defaults to IDENTITY_SITENAME
# IDENTITY_TITLENAME="Vagrant IXP Manager"
IDENTITY_LEGALNAME="Vagrant City IXP"
IDENTITY_CITY="Dublin"
IDENTITY_COUNTRY="IE"
IDENTITY_ORGNAME="${IDENTITY_LEGALNAME}"
# As well as uses in other places, emails are sent from the following name/email:
IDENTITY_NAME="${IDENTITY_LEGALNAME}"
IDENTITY_EMAIL="[email protected]"
IDENTITY_TESTEMAIL="${IDENTITY_EMAIL}"
# Used on some traffic graphs:
IDENTITY_WATERMARK="Vagrant City IXP"
IDENTITY_SUPPORT_EMAIL="${IDENTITY_EMAIL}"
IDENTITY_SUPPORT_PHONE="+1 111 555 5555"
IDENTITY_SUPPORT_HOURS="24x7"
IDENTITY_BILLING_EMAIL="${IDENTITY_EMAIL}"
IDENTITY_BILLING_PHONE="+1 111 555 5555"
IDENTITY_BILLING_HOURS="24x7"
# Web address of your IXP's website. Used in IX-F Export schema, etc.
IDENTITY_CORPORATE_URL="http://www.example.com/"
# The logo to show on the login page. Should be a URL.
# (the example here works - the leading '//' means the browser should match http/https based on the web page)
IDENTITY_BIGLOGO="//www.ixpmanager.org/images/logos/ixp-manager.png"
# For some actions (e.g. peering matrix) we need to know what VLAN to show by default.
# This is the vlan.id database entry (i.e. not the VLAN number/tag!)
IDENTITY_DEFAULT_VLAN=1
#########################################################################################
### Member vs. Customer
###
### IXP Manager is an open source project and typically used in member-owned IXPs.
### As such, the language used mostly is 'member'. To change this to 'customer' just
### uncomment the following lines:
#
# IXP_FE_FRONTEND_CUSTOMER_ONE=customer
# IXP_FE_FRONTEND_CUSTOMER_MANY=customers
# IXP_FE_FRONTEND_CUSTOMER_OWNER="customer's"
# IXP_FE_FRONTEND_CUSTOMER_OWNERS="customers'"
#######################################################################################
### Features
#
# See: http://docs.ixpmanager.org/features/reseller/
IXP_RESELLER_ENABLED=false
# See: http://docs.ixpmanager.org/features/as112/
IXP_AS112_UI_ACTIVE=false
#######################################################################################
### Frontend controllers and controller configuration
#
# Some frontend controllers are disabled by default. This is for a variety of reasons
# including: additional configuration may be required, maintain backwards
# compatibility, etc.
# Allow customers / admins to upload logos for members. Set to false to enabled.
# See: http://docs.ixpmanager.org/usage/customers/#customer-logos
IXP_FE_FRONTEND_DISABLED_LOGO=false
# Send email notifications when a customer's billing details are updated.
# See: http://docs.ixpmanager.org/usage/customers/#notification-of-billing-details-changed
# IXP_FE_CUSTOMER_BILLING_UPDATES_NOTIFY="[email protected]"
# Disable links to the peering matrix if you have not set it up (with sflow):
# IXP_FE_FRONTEND_DISABLED_PEERING_MATRIX=true
# Enable the UI for route server community-based filtering by uncommenting this line:
# IXP_FE_FRONTEND_DISABLED_RS_FILTERS=false
#######################################################################################
### Graphing - see https://docs.ixpmanager.org/grapher/introduction
# Enable the backends you have configured. E.g.:
# GRAPHER_BACKENDS="mrtg|sflow|smokeping"
# On a new installation, we just use placeholders from the dummy backend:
GRAPHER_BACKENDS="dummy"
# With the cache enabled, IXP Manager does not have to regenerate / reload / reprocess
# log / rrd / image files if we have cached them and they are less than 5mins old. This
# is enabled by default which is the recommended setting.
GRAPHER_CACHE_ENABLED=true
#################################################################################
## Grapher - Mrtg - see: https://docs.ixpmanager.org/grapher/mrtg/
##
# For backwards compatibility, the default is 'log' but 'rrd' is more modern:
GRAPHER_BACKEND_MRTG_DBTYPE="rrd"
# The defaults for these are '/tmp' to require you to change them to something
# more sensible such as:
# GRAPHER_BACKEND_MRTG_WORKDIR="/srv/mrtg"
# GRAPHER_BACKEND_MRTG_LOGDIR="/srv/mrtg"
#################################################################################
## Grapher - sflow - see: https://docs.ixpmanager.org/grapher/sflow/
##
# GRAPHER_BACKEND_SFLOW_ENABLED=false
# GRAPHER_BACKEND_SFLOW_ROOT="http://sflow-server.example.com/grapher-sflow"
#################################################################################
## Grapher - smokeping - see: https://docs.ixpmanager.org/grapher/smokeping/
##
# Mark it as enabled (this just affects whether certain UI elements are shown):
# GRAPHER_BACKEND_SMOKEPING_ENABLED=true
# And set the default location to fetch the Smokeping graphs from:
# GRAPHER_BACKEND_SMOKEPING_URL="http://www.example.com/smokeping"
#################################################################################
## IX-F Member Export - see: https://docs.ixpmanager.org/features/ixf-export/
# IXP_API_JSONEXPORTSCHEMA_PUBLIC=true
# Some variables can be excluded as required.
# See: https://docs.ixpmanager.org/features/ixf-export/
#
# IXP_API_JSONEXPORTSCHEMA_EXCLUDE_SWITCH="model|software"
# IXP_API_JSONEXPORTSCHEMA_EXCLUDE_IXP="name|url"
# IXP_API_JSONEXPORTSCHEMA_EXCLUDE_MEMBER="asnum|name"
# IXP_API_JSONEXPORTSCHEMA_EXCLUDE_INTINFO="mac_addresses|routeserver"
# Exclude members with certain AS numbers
# IXP_API_JSONEXPORTSCHEMA_EXCLUDE_ASNUM="65001|65002|65003"
# Exclude members with certain tags
# IXP_API_JSONEXPORTSCHEMA_EXCLUDE_TAGS="tag1|tag2"
# Exclude documentation ASNs (64496 - 64511, 65536 - 65551)
# IXP_API_JSONEXPORTSCHEMA_EXCLUDE_RFC5398=true
# Exclude private ASNs (64512 - 65534, 4200000000 - 4294967294)
# Exclude private ASNs:
# IXP_API_JSONEXPORTSCHEMA_EXCLUDE_RFC6996=true
#######################################################################################
### Skinning
#
# See https://ixp-manager.readthedocs.io/en/latest/features/skinning.html
#
# VIEW_SKIN="myskin"
#######################################################################################
# See config/cache.php
CACHE_DRIVER=array
#######################################################################################
# Session Lifetimes - standard and remember me.
#
# See https://docs.ixpmanager.org/usage/authentication/
#
# SESSION_LIFETIME=120
# AUTH_TOKEN_EXPIRE=43200
#######################################################################################
# PeeringDB Authentication
#
# PeeringDb's API is used, for example, to pre-populate new customer details. If you
# provide a working PeeringDb username/password then these will be used to get more
# complete information.
#
# IXP_API_PEERING_DB_USERNAME=username
# IXP_API_PEERING_DB_PASSWORD=password
#######################################################################################
# Options for updating RIR Objects - see https://docs.ixpmanager.org/features/rir-objects/
# Your RIR password to allow the updating of a RIR object by email:
# IXP_API_RIR_PASSWORD=soopersecret
# Rather than specifiying the destination address on the command line, you can set it here
# (useful for cronjobs and required for use with artisan schedule:run in >=v5.0)
# Rather than specifiying the from address on the command line, you can set it here
# (useful for cronjobs and required for use with artisan schedule:run in >=v5.0)
#######################################################################################
# Utility paths
# See: https://docs.ixpmanager.org/features/irrdb/
IXP_IRRDB_BGPQ3_PATH=/usr/bin/bgpq3
# See: https://docs.ixpmanager.org/features/rpki/
# IXP_RPKI_RTR1_HOST=192.0.2.11
# IXP_RPKI_RTR1_PORT=3323
# IXP_RPKI_RTR2_HOST=192.0.2.12
# IXP_RPKI_RTR2_PORT=3323
#########################################################################################
### Development Helpers
###
# Disable HTML5 validation to test PHP code based request validators
# FORMER_LIVE_VALIDATION=false
#########################################################################################
### PeeringDB OAuth
###
### https://docs.ixpmanager.org/features/peeringdb-oauth/
###
# AUTH_PEERINGDB_ENABLED=true
# PEERINGDB_OAUTH_CLIENT_ID="xxx"
# PEERINGDB_OAUTH_CLIENT_SECRET="xxx"
# PEERINGDB_OAUTH_REDIRECT="https://www.example.com/auth/login/peeringdb/callback"
#########################################################################################
### See: https://docs.ixpmanager.org/features/routers/#filtering-known-transit-networks
# IXP_NO_TRANSIT_ASNS_EXCLUDE=65501,65502
# IXP_NO_TRANSIT_ASNS_OVERRIDE=65501,65502,65503