Commit b3b1657b0861687631e9a4016dc68cee7c4a9e73
Committed by
Andrew Shvayka
1 parent
d44ab082
Fix typos and remove trailing whitespaces
[ci skip]
Showing
1 changed file
with
21 additions
and
21 deletions
1 | -# Docker configuration for ThingsBoard Microservices | 1 | +# Docker configuration for ThingsBoard Microservices |
2 | 2 | ||
3 | This folder containing scripts and Docker Compose configurations to run ThingsBoard in Microservices mode. | 3 | This folder containing scripts and Docker Compose configurations to run ThingsBoard in Microservices mode. |
4 | 4 | ||
@@ -9,19 +9,19 @@ Before starting please make sure [Docker CE](https://docs.docker.com/install/) a | @@ -9,19 +9,19 @@ Before starting please make sure [Docker CE](https://docs.docker.com/install/) a | ||
9 | 9 | ||
10 | ## Installation | 10 | ## Installation |
11 | 11 | ||
12 | -Before performing initial installation you can configure the type of database to be used with ThinsBoard. | 12 | +Before performing initial installation you can configure the type of database to be used with ThingsBoard. |
13 | In order to set database type change the value of `DATABASE` variable in `.env` file to one of the following: | 13 | In order to set database type change the value of `DATABASE` variable in `.env` file to one of the following: |
14 | 14 | ||
15 | - `postgres` - use PostgreSQL database; | 15 | - `postgres` - use PostgreSQL database; |
16 | - `cassandra` - use Cassandra database; | 16 | - `cassandra` - use Cassandra database; |
17 | - | ||
18 | -**NOTE**: According to the database type corresponding docker service will be deployed (see `docker-compose.postgres.yml`, `docker-compose.cassandra.yml` for details). | 17 | + |
18 | +**NOTE**: According to the database type corresponding docker service will be deployed (see `docker-compose.postgres.yml`, `docker-compose.cassandra.yml` for details). | ||
19 | 19 | ||
20 | Execute the following command to run installation: | 20 | Execute the following command to run installation: |
21 | 21 | ||
22 | -` | 22 | +` |
23 | $ ./docker-install-tb.sh --loadDemo | 23 | $ ./docker-install-tb.sh --loadDemo |
24 | -` | 24 | +` |
25 | 25 | ||
26 | Where: | 26 | Where: |
27 | 27 | ||
@@ -31,56 +31,56 @@ Where: | @@ -31,56 +31,56 @@ Where: | ||
31 | 31 | ||
32 | Execute the following command to start services: | 32 | Execute the following command to start services: |
33 | 33 | ||
34 | -` | 34 | +` |
35 | $ ./docker-start-services.sh | 35 | $ ./docker-start-services.sh |
36 | -` | 36 | +` |
37 | 37 | ||
38 | After a while when all services will be successfully started you can open `http://{your-host-ip}` in you browser (for ex. `http://localhost`). | 38 | After a while when all services will be successfully started you can open `http://{your-host-ip}` in you browser (for ex. `http://localhost`). |
39 | You should see ThingsBoard login page. | 39 | You should see ThingsBoard login page. |
40 | 40 | ||
41 | Use the following default credentials: | 41 | Use the following default credentials: |
42 | 42 | ||
43 | -- **Systen Administrator**: sysadmin@thingsboard.org / sysadmin | 43 | +- **System Administrator**: sysadmin@thingsboard.org / sysadmin |
44 | 44 | ||
45 | If you installed DataBase with demo data (using `--loadDemo` flag) you can also use the following credentials: | 45 | If you installed DataBase with demo data (using `--loadDemo` flag) you can also use the following credentials: |
46 | 46 | ||
47 | - **Tenant Administrator**: tenant@thingsboard.org / tenant | 47 | - **Tenant Administrator**: tenant@thingsboard.org / tenant |
48 | - **Customer User**: customer@thingsboard.org / customer | 48 | - **Customer User**: customer@thingsboard.org / customer |
49 | 49 | ||
50 | -In case of any issues you can examine service logs for errors. | 50 | +In case of any issues you can examine service logs for errors. |
51 | For example to see ThingsBoard node logs execute the following command: | 51 | For example to see ThingsBoard node logs execute the following command: |
52 | 52 | ||
53 | -` | 53 | +` |
54 | $ docker-compose logs -f tb1 | 54 | $ docker-compose logs -f tb1 |
55 | -` | 55 | +` |
56 | 56 | ||
57 | Or use `docker-compose ps` to see the state of all the containers. | 57 | Or use `docker-compose ps` to see the state of all the containers. |
58 | Use `docker-compose logs --f` to inspect the logs of all running services. | 58 | Use `docker-compose logs --f` to inspect the logs of all running services. |
59 | -See [docker-compose logs](https://docs.docker.com/compose/reference/logs/) command reference for details. | 59 | +See [docker-compose logs](https://docs.docker.com/compose/reference/logs/) command reference for details. |
60 | 60 | ||
61 | Execute the following command to stop services: | 61 | Execute the following command to stop services: |
62 | 62 | ||
63 | -` | 63 | +` |
64 | $ ./docker-stop-services.sh | 64 | $ ./docker-stop-services.sh |
65 | -` | 65 | +` |
66 | 66 | ||
67 | Execute the following command to stop and completely remove deployed docker containers: | 67 | Execute the following command to stop and completely remove deployed docker containers: |
68 | 68 | ||
69 | -` | 69 | +` |
70 | $ ./docker-remove-services.sh | 70 | $ ./docker-remove-services.sh |
71 | -` | 71 | +` |
72 | 72 | ||
73 | Execute the following command to update particular or all services (pull newer docker image and rebuild container): | 73 | Execute the following command to update particular or all services (pull newer docker image and rebuild container): |
74 | 74 | ||
75 | -` | 75 | +` |
76 | $ ./docker-update-service.sh [SERVICE...] | 76 | $ ./docker-update-service.sh [SERVICE...] |
77 | -` | 77 | +` |
78 | 78 | ||
79 | Where: | 79 | Where: |
80 | 80 | ||
81 | -- `[SERVICE...]` - list of services to update (defined in docker-compose configurations). If not specified all services will be updated. | 81 | +- `[SERVICE...]` - list of services to update (defined in docker-compose configurations). If not specified all services will be updated. |
82 | 82 | ||
83 | -## Upgrading | 83 | +## Upgrading |
84 | 84 | ||
85 | In case when database upgrade is needed, execute the following commands: | 85 | In case when database upgrade is needed, execute the following commands: |
86 | 86 |