{"id":21371502,"url":"https://github.com/chirpstack/chirpstack-docker","last_synced_at":"2025-05-15T11:02:22.801Z","repository":{"id":41403764,"uuid":"127895257","full_name":"chirpstack/chirpstack-docker","owner":"chirpstack","description":"Setup ChirpStack using Docker Compose","archived":false,"fork":false,"pushed_at":"2025-01-10T16:02:49.000Z","size":89,"stargazers_count":304,"open_issues_count":14,"forks_count":339,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-04-07T10:17:41.384Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.chirpstack.io/","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chirpstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"chirpstack"}},"created_at":"2018-04-03T11:05:42.000Z","updated_at":"2025-04-04T07:58:02.000Z","dependencies_parsed_at":"2023-11-21T15:46:49.997Z","dependency_job_id":"c30dc5cf-ba31-471d-9c9f-8c10f2ee9c54","html_url":"https://github.com/chirpstack/chirpstack-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fchirpstack-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fchirpstack-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fchirpstack-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fchirpstack-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chirpstack","download_url":"https://codeload.github.com/chirpstack/chirpstack-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248912102,"owners_count":21182216,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T08:13:40.949Z","updated_at":"2025-04-14T15:54:48.718Z","avatar_url":"https://github.com/chirpstack.png","language":"Makefile","readme":"# ChirpStack Docker example\n\nThis repository contains a skeleton to setup the [ChirpStack](https://www.chirpstack.io)\nopen-source LoRaWAN Network Server (v4) using [Docker Compose](https://docs.docker.com/compose/).\n\n**Note:** Please use this `docker-compose.yml` file as a starting point for testing\nbut keep in mind that for production usage it might need modifications. \n\n## Directory layout\n\n* `docker-compose.yml`: the docker-compose file containing the services\n* `configuration/chirpstack`: directory containing the ChirpStack configuration files\n* `configuration/chirpstack-gateway-bridge`: directory containing the ChirpStack Gateway Bridge configuration\n* `configuration/mosquitto`: directory containing the Mosquitto (MQTT broker) configuration\n* `configuration/postgresql/initdb/`: directory containing PostgreSQL initialization scripts\n\n## Configuration\n\nThis setup is pre-configured for all regions. You can either connect a ChirpStack Gateway Bridge\ninstance (v3.14.0+) to the MQTT broker (port 1883) or connect a Semtech UDP Packet Forwarder.\nPlease note that:\n\n* You must prefix the MQTT topic with the region.\n  Please see the region configuration files in the `configuration/chirpstack` for a list\n  of topic prefixes (e.g. eu868, us915_0, au915_0, as923_2, ...).\n* The protobuf marshaler is configured.\n\nThis setup also comes with two instances of the ChirpStack Gateway Bridge. One\nis configured to handle the Semtech UDP Packet Forwarder data (port 1700), the\nother is configured to handle the Basics Station protocol (port 3001). Both\ninstances are by default configured for EU868 (using the `eu868` MQTT topic\nprefix).\n\n### Reconfigure regions\n\nChirpStack has at least one configuration of each region enabled. You will find\nthe list of `enabled_regions` in `configuration/chirpstack/chirpstack.toml`.\nEach entry in `enabled_regions` refers to the `id` that can be found in the\n`region_XXX.toml` file. This `region_XXX.toml` also contains a `topic_prefix`\nconfiguration which you need to configure the ChirpStack Gateway Bridge\nUDP instance (see below).\n\n#### ChirpStack Gateway Bridge (UDP)\n\nWithin the `docker-compose.yml` file, you must replace the `eu868` prefix in the\n`INTEGRATION__..._TOPIC_TEMPLATE` configuration with the MQTT `topic_prefix` of\nthe region you would like to use (e.g. `us915_0`, `au915_0`, `in865`, ...).\n\n#### ChirpStack Gateway Bridge (Basics Station)\n\nWithin the `docker-compose.yml` file, you must update the configuration file\nthat the ChirpStack Gateway Bridge instance must used. The default is\n`chirpstack-gateway-bridge-basicstation-eu868.toml`. For available\nconfiguration files, please see the `configuration/chirpstack-gateway-bridge`\ndirectory.\n\n# Data persistence\n\nPostgreSQL and Redis data is persisted in Docker volumes, see the `docker-compose.yml`\n`volumes` definition.\n\n## Requirements\n\nBefore using this `docker-compose.yml` file, make sure you have [Docker](https://www.docker.com/community-edition)\ninstalled.\n\n## Importing device repository\n\nTo import the [lorawan-devices](https://github.com/TheThingsNetwork/lorawan-devices)\nrepository (optional step), run the following command:\n\n```bash\nmake import-lorawan-devices\n```\n\nThis will clone the `lorawan-devices` repository and execute the import command of ChirpStack.\nPlease note that for this step you need to have the `make` command installed.\n\n**Note:** an older snapshot of the `lorawan-devices` repository is cloned as the\nlatest revision no longer contains a `LICENSE` file.\n\n## Usage\n\nTo start the ChirpStack simply run:\n\n```bash\n$ docker-compose up\n```\n\nAfter all the components have been initialized and started, you should be able\nto open http://localhost:8080/ in your browser.\n\n##\n\nThe example includes the [ChirpStack REST API](https://github.com/chirpstack/chirpstack-rest-api).\nYou should be able to access the UI by opening http://localhost:8090 in your browser.\n\n**Note:** It is recommended to use the [gRPC](https://www.chirpstack.io/docs/chirpstack/api/grpc.html)\ninterface over the [REST](https://www.chirpstack.io/docs/chirpstack/api/rest.html) interface.\n","funding_links":["https://github.com/sponsors/chirpstack"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchirpstack%2Fchirpstack-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchirpstack%2Fchirpstack-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchirpstack%2Fchirpstack-docker/lists"}