Skip to content

Commit 4b82662

Browse files
committed
README: Make organization creation have a section heading.
This should make it harder to miss, which apparently does happen with the current placement under management commands. Note also that we add missing quoting. Fixes #331.
1 parent 2de7686 commit 4b82662

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -266,10 +266,21 @@ login until you create an organization, but visiting the URL is a good
266266
way to confirm that your networking configuration is working
267267
correctly.
268268

269-
You can now follow the normal instructions for how to
269+
### Creating your organization
270+
271+
You can now follow the normal Zulip installer instructions for how to
270272
[create a Zulip organization and log in][create-organization] to your
271-
new Zulip server (though see the following section for how to run
272-
management commands).
273+
new Zulip server. You'll generate the realm creation link as follows:
274+
275+
```bash
276+
docker-compose exec -u zulip zulip \
277+
"/home/zulip/deployments/current/manage.py generate_realm_creation_link"
278+
```
279+
280+
But don't forget to review the [getting started][next-steps] links at
281+
the end of the main installation guide.
282+
283+
[next-steps]: https://zulip.readthedocs.io/en/latest/production/install.html#getting-started-with-zulip
273284

274285
### Running management commands
275286

@@ -280,9 +291,9 @@ The following are helpful examples:
280291
```bash
281292
# Get a (root) shell in the container so you can access logs
282293
docker-compose exec zulip bash
283-
# Create the initial Zulip organization
294+
# Run a Zulip management command
284295
docker-compose exec -u zulip zulip \
285-
/home/zulip/deployments/current/manage.py generate_realm_creation_link
296+
"/home/zulip/deployments/current/manage.py list_realms"
286297
```
287298

288299
Since that process for running management commands is a pain, we recommend

0 commit comments

Comments
 (0)