Skip to content

Commit a383018

Browse files
Updated docs to reflect that chirpstack has been updated (#15)
1 parent 50ef664 commit a383018

File tree

4 files changed

+8
-41
lines changed

4 files changed

+8
-41
lines changed

source/external-interface-design/external-interface-design.rst

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ and Chirpstack is out of scope of this project.
130130

131131
|image6|
132132

133-
The Chirpstack is comprised of the following 5 modules.
133+
The Chirpstack is comprised of the following 4 modules.
134134

135135
1. `Appplication
136136
Server <https://www.chirpstack.io/application-server/use/fuota/>`__
@@ -139,11 +139,7 @@ The Chirpstack is comprised of the following 5 modules.
139139

140140
3. `Gateway bridge <https://www.chirpstack.io/gateway-bridge/>`__
141141

142-
4. `Geolocation
143-
server <https://www.chirpstack.io/geolocation-server/>`__ (only for
144-
locating edge devices)
145-
146-
5. A postgresql database
142+
4. A postgresql database
147143

148144
Data synchronization
149145
~~~~~~~~~~~~~~~~~~~~

source/maintenance-guide/maintenance-guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Starting dependencies for development
9595

9696
.. code-block:: bash
9797
98-
docker-compose up chirpstack-network-server postgresql chirpstack-gateway-bridge chirpstack-geolocation-server chirpstack-application-server os2iot-outbound-mosquitto mosquitto redis os2iot-inbound-mosquitto os2iot-kafka os2iot-postgresql os2iot-zookeeper
98+
docker-compose up chirpstack-network-server postgresql chirpstack-gateway-bridge chirpstack-application-server os2iot-outbound-mosquitto mosquitto redis os2iot-inbound-mosquitto os2iot-kafka os2iot-postgresql os2iot-zookeeper
9999
100100
3. To quit: In your terminal you can press Ctrl + C twice. This will safely shut down docker.
101101

source/testing/testing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Running the tests
2525

2626
a. Start the dependencies using docker-compose from te OS2IoT-docker folder:
2727

28-
i. :code:`docker-compose up --force-recreate --build -d chirpstack-network-server postgresql chirpstack-gateway-bridge chirpstack-geolocation-server chirpstack-application-server os2iot-outbound-mosquitto mosquitto redis os2iot-inbound-mosquitto os2iot-kafka os2iot-postgresql os2iot-zookeeper`
28+
i. :code:`docker-compose up --force-recreate --build -d chirpstack-network-server postgresql chirpstack-gateway-bridge chirpstack-application-server os2iot-outbound-mosquitto mosquitto redis os2iot-inbound-mosquitto os2iot-kafka os2iot-postgresql os2iot-zookeeper`
2929

3030
2. Install dependencies to run test from the OS2IoT-backend folder:
3131

source/users-notes/users-notes.rst

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -25,41 +25,12 @@ How to change chirpstacks admin password
2525
Step-by-step:
2626
############
2727

28-
1. Create a user (e.g. [email protected]) in Chirpstack with the wanted password.
29-
2. Change the password_hash for ’admin’ in the postgres-database:
30-
a. SSH into the server
31-
b. docker exec -it os2iot-docker_postgresql_1 sh
32-
c. psql -U chirpstack_as
33-
d. update public.user set password_hash = (select password_hash from public.user where email = '[email protected]') where id=1;
34-
e. Now the user has been updated
35-
3. Delete the user created in step 1
28+
1. Log in to the ChirpStack Application Server web interface using the default credentials
29+
2. Change the password of the admin user under: 'All users' -> 'admin' -> 'Change Password'
3630

31+
In previous versions of ChirpStack Application Server it wasn't possible to change the admin user password through the UI, but since v.3.13.0 this as worked as expected.
3732

38-
39-
Background information:
40-
######################
41-
42-
43-
In order for OS2iot to function, there must be an admin user in chirpstack named admin. This is because Chirpstacks API requires an JWT including ’username’. You can read about JWT here: https://jwt.io/ and decode:
44-
’ eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaGlycHN0YWNrLWFwcGxpY2F0aW9uLXNlcnZlciIsImV4cCI6MTYxODkyMTQ1NiwiaWQiOjEsImlzcyI6ImNoaXJwc3RhY2stYXBwbGljYXRpb24tc2VydmVyIiwibmJmIjoxNjE4ODM1MDU2LCJzdWIiOiJ1c2VyIiwidXNlcm5hbWUiOiJhZG1pbiJ9.H1ildZ6dj3_G-BkI9EPW6QJk_3QowpLUY4lL4vCcvX0’
45-
46-
to
47-
48-
’ {
49-
"aud": "chirpstack-application-server",
50-
"exp": 1618921456,
51-
"id": 1,
52-
"iss": "chirpstack-application-server",
53-
"nbf": 1618835056,
54-
"sub": "user",
55-
"username": "admin"
56-
}’
57-
58-
That is, if the username is changed the JWT will not work anymore.
59-
60-
Chirpstack requires that all its users has an e-mail, when they are created or changed (Including change of password). Nevertheless, when the application is created the first time / the database is created this is not a requirement. This is why you will not be able to change the password using Chirpstacks UI.
61-
62-
It is possible to change the requirement that the user must be named admin here:
33+
Alternatively the Admin user can removed and replaced by another user entirely. This requires changing the user name that OS2iot-backend uses:
6334
https://github.com/OS2iot/OS2IoT-backend/blob/master/src/services/chirpstack/jwt-token.ts#L17
6435

6536

0 commit comments

Comments
 (0)