Skip to content

Commit

Permalink
Readme: Add some pointers to what to do after the quick start
Browse files Browse the repository at this point in the history
Closes #3075
  • Loading branch information
ralight committed Oct 3, 2024
1 parent e96ddfc commit 9f69df4
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ various platforms.
## Quick start

If you have installed a binary package the broker should have been started
automatically. If not, it can be started with a basic configuration:
automatically. If not, it can be started with a very basic configuration:

mosquitto

Expand All @@ -42,6 +42,23 @@ And to publish a message:

mosquitto_pub -t 'test/topic' -m 'hello world'

Note that starting the broker like this allows anonymous/unauthenticated access
but only from the local computer, so it's only really useful for initial testing.

If you want to have clients from another computer connect, you will need to
provide a configuration file. If you have installed from a binary package, you
will probably already have a configuration file at somewhere like
`/etc/mosquitto/mosquitto.conf`. If you've compiled from source, you can write
your config file then run as `mosquitto -c /path/to/mosquitto.conf`.

To start your config file you define a listener and you will need to think
about what authentication you require. It is not advised to run your broker
with anonymous access when it is publically available.

For details on how to do this, look at the
[authentication methods](https://mosquitto.org/documentation/authentication-methods/)
available and the [dynamic security plugin](https://mosquitto.org/documentation/dynamic-security/).

## Documentation

Documentation for the broker, clients and client library API can be found in
Expand Down

0 comments on commit 9f69df4

Please sign in to comment.