|
| 1 | +import { Steps, Aside } from '@astrojs/starlight/components'; |
| 2 | +import ImageGallery from '~/components/ImageGallery.astro'; |
| 3 | +import Checklist from '~/components/Checklist.astro'; |
| 4 | +import Box from '~/components/tutorial/Box.astro'; |
| 5 | + |
| 6 | +First, add a gateway device to your ThingsBoard instance by following these steps: |
| 7 | + |
| 8 | +<Steps> |
| 9 | +1. Go to **Entities** > **Gateways** tab. |
| 10 | + |
| 11 | + <ImageGallery images={[ |
| 12 | + { |
| 13 | + src: '/src/assets/images/gateway/dashboard/gateway-getting-started-1-ce.png', |
| 14 | + alt: 'Go to Entities > Gateways tab', |
| 15 | + }, |
| 16 | + ]} /> |
| 17 | + |
| 18 | +2. Click the **+** button, enter the gateway device name (e.g., "My Gateway"), and select the device profile. Click on **Create** button. |
| 19 | + |
| 20 | + <ImageGallery images={[ |
| 21 | + { |
| 22 | + src: '/src/assets/images/gateway/dashboard/gateway-getting-started-2-ce.png', |
| 23 | + alt: 'Create new gateway device', |
| 24 | + }, |
| 25 | + ]} /> |
| 26 | +</Steps> |
| 27 | + |
| 28 | +<Aside type="note"> |
| 29 | +If you've previously configured the gateway, create a backup, as the new remote configuration will overwrite existing settings files. |
| 30 | +For those who used a gateway version earlier than 3.4, the gateway will automatically generate a new configuration file in JSON format. |
| 31 | +</Aside> |
| 32 | + |
| 33 | +To launch the gateway, use the following steps: |
| 34 | + |
| 35 | +<Steps> |
| 36 | +1. Select and click on newly created gateway, click on **Launch command** button in the top right corner. |
| 37 | + |
| 38 | + <ImageGallery images={[ |
| 39 | + { |
| 40 | + src: '/src/assets/images/gateway/dashboard/gateway-getting-started-3-ce.png', |
| 41 | + alt: 'Click Launch command button', |
| 42 | + }, |
| 43 | + ]} /> |
| 44 | + |
| 45 | +2. Click to download `docker-compose.yml` file to your PC, copy command and execute it in your terminal. |
| 46 | + |
| 47 | + <ImageGallery images={[ |
| 48 | + { |
| 49 | + src: '/src/assets/images/gateway/dashboard/gateway-getting-started-4-ce.png', |
| 50 | + alt: 'Download docker-compose.yml and run command', |
| 51 | + }, |
| 52 | + ]} /> |
| 53 | +</Steps> |
| 54 | + |
| 55 | +After running gateway docker image, you can see the following logs in your terminal: |
| 56 | + |
| 57 | +<ImageGallery images={[ |
| 58 | + { |
| 59 | + src: '/src/assets/images/gateway/dashboard/launch-gateway-docker.png', |
| 60 | + alt: 'Gateway Docker logs in terminal', |
| 61 | + }, |
| 62 | +]} /> |
| 63 | + |
| 64 | +<Box icon="check-list"> |
| 65 | +### Checklist for Moving On |
| 66 | + |
| 67 | +<Checklist> |
| 68 | +- [ ] I have created a gateway device in ThingsBoard. |
| 69 | +- [ ] I have launched the gateway using Docker. |
| 70 | +</Checklist> |
| 71 | +</Box> |
0 commit comments