|
@ -1,14 +1,14 @@ |
|
|
# Running goneb |
|
|
|
|
|
|
|
|
# Running go-neb |
|
|
|
|
|
|
|
|
Goneb uses environment variables to configure its database and bind address. |
|
|
|
|
|
To run goneb: |
|
|
|
|
|
|
|
|
Go-neb uses environment variables to configure its database and bind address. |
|
|
|
|
|
To run go-neb: |
|
|
|
|
|
|
|
|
BIND_ADDRESS=:4050 DATABASE_TYPE=sqlite3 DATABASE_URL=goneb.db bin/goneb |
|
|
|
|
|
|
|
|
BIND_ADDRESS=:4050 DATABASE_TYPE=sqlite3 DATABASE_URL=go-neb.db bin/go-neb |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Goneb needs to connect as a matrix user to receive messages. Goneb can listen |
|
|
|
|
|
|
|
|
Go-neb needs to connect as a matrix user to receive messages. Go-neb can listen |
|
|
for messages as multiple matrix users. The users are configured using an |
|
|
for messages as multiple matrix users. The users are configured using an |
|
|
HTTP API and the config is stored in the database. Goneb will automatically |
|
|
|
|
|
|
|
|
HTTP API and the config is stored in the database. Go-neb will automatically |
|
|
start syncing matrix messages when the user is configured. To create a user: |
|
|
start syncing matrix messages when the user is configured. To create a user: |
|
|
|
|
|
|
|
|
curl -X POST localhost:4050/admin/configureClient --data-binary '{ |
|
|
curl -X POST localhost:4050/admin/configureClient --data-binary '{ |
|
@ -25,11 +25,11 @@ start syncing matrix messages when the user is configured. To create a user: |
|
|
} |
|
|
} |
|
|
} |
|
|
} |
|
|
|
|
|
|
|
|
Services in goneb listen for messages in particular rooms using a given matrix |
|
|
|
|
|
|
|
|
Services in go-neb listen for messages in particular rooms using a given matrix |
|
|
user. Services are configured using an HTTP API and the config is stored in the |
|
|
user. Services are configured using an HTTP API and the config is stored in the |
|
|
database. Services use one of the matrix users configured on goneb to receive |
|
|
|
|
|
|
|
|
database. Services use one of the matrix users configured on go-neb to receive |
|
|
matrix messages. Each service is configured to listen for messages in a set |
|
|
matrix messages. Each service is configured to listen for messages in a set |
|
|
of rooms. Goneb will automatically join the service to its rooms when it is |
|
|
|
|
|
|
|
|
of rooms. Go-neb will automatically join the service to its rooms when it is |
|
|
configured. To start a service: |
|
|
configured. To start a service: |
|
|
|
|
|
|
|
|
curl -X POST localhost:4050/admin/configureService --data-binary '{ |
|
|
curl -X POST localhost:4050/admin/configureService --data-binary '{ |
|
@ -50,7 +50,7 @@ configured. To start a service: |
|
|
} |
|
|
} |
|
|
} |
|
|
} |
|
|
|
|
|
|
|
|
Goneb has a heartbeat listener that returns 200 OK so that load balancers can |
|
|
|
|
|
|
|
|
Go-neb has a heartbeat listener that returns 200 OK so that load balancers can |
|
|
check that the server is still running. |
|
|
check that the server is still running. |
|
|
|
|
|
|
|
|
curl -X GET localhost:4050/test |
|
|
curl -X GET localhost:4050/test |
|
|