From 4b82662b64e455ac82225dded040d18141dfa517 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Wed, 25 Sep 2024 17:55:12 -0700 Subject: [PATCH] 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. --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ad46136..666b06b 100644 --- a/README.md +++ b/README.md @@ -266,10 +266,21 @@ login until you create an organization, but visiting the URL is a good way to confirm that your networking configuration is working correctly. -You can now follow the normal instructions for how to +### Creating your organization + +You can now follow the normal Zulip installer instructions for how to [create a Zulip organization and log in][create-organization] to your -new Zulip server (though see the following section for how to run -management commands). +new Zulip server. You'll generate the realm creation link as follows: + +```bash +docker-compose exec -u zulip zulip \ + "/home/zulip/deployments/current/manage.py generate_realm_creation_link" +``` + +But don't forget to review the [getting started][next-steps] links at +the end of the main installation guide. + +[next-steps]: https://zulip.readthedocs.io/en/latest/production/install.html#getting-started-with-zulip ### Running management commands @@ -280,9 +291,9 @@ The following are helpful examples: ```bash # Get a (root) shell in the container so you can access logs docker-compose exec zulip bash -# Create the initial Zulip organization +# Run a Zulip management command docker-compose exec -u zulip zulip \ - /home/zulip/deployments/current/manage.py generate_realm_creation_link + "/home/zulip/deployments/current/manage.py list_realms" ``` Since that process for running management commands is a pain, we recommend