Improve docker-compose deployment & documentation
[portal/nonrtric-controlpanel.git] / docker-compose / README.md
1 # License
2
3 Copyright (C) 2020 Nordix Foundation.
4 Licensed under the Apache License, Version 2.0 (the "License")
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8       http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15
16 For more information about license please see the [LICENSE](LICENSE.txt) file for details.
17
18 ## O-RAN-SC docker-compose files
19
20 The docker compose file helps the user to deploy the components of nonrtric control panel with one command.
21
22 NOTE:
23 docker image urls & tags are in file ```.env```
24
25 To install the Control Panel and gateway, run the following command:
26
27 ```shell
28 docker-compose --env-file .env -f docker-compose.yaml -f control-panel/docker-compose.yaml -f nonrtric-gateway/docker-compose.yaml up -d
29 ```
30
31 To remove the containers, use the command:
32
33 ```shell
34 docker-compose --env-file .env -f docker-compose.yaml -f control-panel/docker-compose.yaml -f nonrtric-gateway/docker-compose.yaml down
35 ```