Docker Compose file checkin for tr069-adapter
[oam/tr069-adapter.git] / docker-compose / tr069-adapter / tr069adapter-install.env
1 # ============LICENSE_START========================================================================
2 # O-RAN-SC : tr-069-adapter
3 # =================================================================================================
4 # Copyright (C) 2020 CommScope Inc Intellectual Property.
5 # =================================================================================================
6 # This tr-069-adapter software file is distributed by CommScope Inc under the Apache License,
7 # Version 2.0 (the "License"); you may not use this file except in compliance with the License. You
8 # may obtain a copy of the License at
9 #
10 # http://www.apache.org/licenses/LICENSE-2.0
11 #
12 # This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13 # either express or implied. See the License for the specific language governing permissions and
14 # limitations under the License.
15 # ===============LICENSE_END=======================================================================
16
17 #
18 # Below 3 are the identites of TR069Adapters. This is needed if any one of the communication is going to be over SSL.
19 #
20 # tr069adapterSSLCert           : Provide the Public Certificate Chain for TR069Adapter
21 # tr069adapterSSLKey            : Provide the Private Key for TR069Adapter
22 # tr069adapterCertPassPhrase    : Provide the PassPhrase used while generating the Public Certificate Chain for TR069Adapter
23
24 tr069adapterSSLCert=tr069adapter.crt
25 tr069adapterSSLKey=tr069adapter.key
26 tr069adapterCertPassPhrase=tr069adapterpassphrase.txt
27
28
29 #
30 # Details for the Fault VES Collector Variables.
31
32 # faultvesCollectorDNSServer    : If the faultvesCollectorHost is not an IP, but a FQDN, then provide the DNS Server IP where this FQDN is configured and will be resolved.
33 # faultvesCollectorHost         : IP of the Fault VES Collector. Allowed values (IPv4/IPv6). If FQDN is provided, then provide the complete FQDN and not just the HOSTNAME. 
34 # faultvesCollectorPort         : Port of the Fault VES Collector.
35 # faultvesCollectorComm         : Communication to and from Fault VES Collector. Allowed values (noAuth/basicAuth/certOnly/certBasicAuth)
36 #       noAuth                  : SSL is disabled.
37 #       basicAuth               : SSL is enabled, and the verification is done via username and password only.
38 #       certOnly                : SSL is enabled, and the verification is done via Certificates only that are imported in VES.
39 #       certBasicAuth           : SSL is enabled, and the verification is done using username and password and also with Certificates.
40 # faultvesCollectorTrustVerify  : If SSL is enabled, then whether to Trust Certificate. Allowed Values (TRUE/FALSE)
41 # faultvesCollectorTrustCRT     : If faultvesCollectorTrustVerify=TRUE, then provide the Trust Certificate Chain
42 # faultvesCollectorBasicAuthUserPassEncrypt : If faultvesCollectorComm=basicAuth or faultvesCollectorComm=certBasicAuth, then provide the encrypted string. To encrypt execute the command 'echo -n "user:pass" | base64'
43
44 faultvesCollectorDNSServer=
45 faultvesCollectorHost=
46 faultvesCollectorPort=8080
47 faultvesCollectorComm=noAuth
48 faultvesCollectorTrustVerify=FALSE
49 faultvesCollectorTrustCRT=faultvestrustcert.pem
50 faultvesCollectorBasicAuthUserPassEncrypt=
51
52 #
53 # Details for the PNF VES Collector Variables.
54 #
55 # pnfregvesCollectorDNSServer   : If the pnfregvesCollectorHost is not an IP, but a FQDN, then provide the DNS Server IP where this FQDN is configured and will be resolved.
56 # pnfregvesCollectorHost        : IP of the PNF VES Collector. Allowed values (IPv4/IPv6). If FQDN is provided, then provide the complete FQDN and not just the HOSTNAME.
57 # pnfregvesCollectorPort        : Port of the PNF VES Collector.
58 # pnfregvesCollectorComm        : Communication to and from PNF VES Collector. Allowed values (noAuth/basicAuth/certOnly/certBasicAuth)
59 #       noAuth                  : SSL is disabled.
60 #       basicAuth               : SSL is enabled, and the verification is done via username and password only.
61 #       certOnly                : SSL is enabled, and the verification is done via Certificates only that are imported in VES.
62 #       certBasicAuth           : SSL is enabled, and the verification is done using username and password and also with Certificates.
63 # pnfregvesCollectorTrustVerify : If SSL is enabled, then whether to Trust Certificate. Allowed Values (TRUE/FALSE)
64 # pnfregvesCollectorTrustCRT    : If pnfregvesCollectorTrustVerify=TRUE, then provide the Trust Certificate Chain
65 # pnfregvesCollectorBasicAuthUserPassEncrypt : If pnfregvesCollectorComm=basicAuth or pnfregvesCollectorComm=certBasicAuth, then provide the encrypted string. To encrypt execute the command 'echo -n "user:pass" | base64'
66
67 pnfregvesCollectorDNSServer=
68 pnfregvesCollectorHost=
69 pnfregvesCollectorPort=8080
70 pnfregvesCollectorComm=noAuth
71 pnfregvesCollectorTrustVerify=FALSE
72 pnfregvesCollectorTrustCRT=pnfvertrustcert.pem
73 pnfregvesCollectorBasicAuthUserPassEncrypt=
74
75 #
76 # Details for the TR069Adapter Variables.
77 #
78 # tr069adapterComm              : Communication to and from TR069Adapter. For all device communications, Factory Import and Config Import. Allowed values (SSL/NO-SSL)
79 # tr069adapterSSLClientAuth     : If tr069adapterComm=SSL, then whether to Authenticate Client Certificate. Allowed Values (TRUE/FALSE)
80 # tr069adapterSSLClientTrustCRT : If tr069adapterSSLClientAuth=TRUE, then provide the Trust Certificate Chain for the client
81
82 tr069adapterComm=NO-SSL
83 tr069adapterSSLClientAuth=FALSE
84 tr069adapterSSLClientTrustCRT=tr069adapterclienttrust.crt
85
86 #
87 # Details for the TR069Adapter Variables.
88 #
89 # netconfServerIP   : IP address of the Server where the Docker containers are hosted. Allowed value is IPv4
90 # DeviceId          : Mac ID of the Device
91
92 netconfServerIP=
93 DeviceId=0005B9423910
94
95