paulmataruso/docker-zulip
1
0
Fork 0
mirror of https://github.com/zulip/docker-zulip.git synced 2025-10-27 01:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

README: Make organization creation have a section heading.

Browse Source 
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.
This commit is contained in:
Tim Abbott
2024-09-25 17:55:12 -07:00
parent 2de76865d2
commit 4b82662b64
1 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -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 way to confirm that your networking configuration is working
correctly. 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 [create a Zulip organization and log in][create-organization] to your
new Zulip server (though see the following section for how to run new Zulip server. You'll generate the realm creation link as follows:
management commands).
```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 ### Running management commands
@@ -280,9 +291,9 @@ The following are helpful examples:
```bash ```bash
# Get a (root) shell in the container so you can access logs # Get a (root) shell in the container so you can access logs
docker-compose exec zulip bash docker-compose exec zulip bash
# Create the initial Zulip organization # Run a Zulip management command
docker-compose exec -u zulip zulip \ 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 Since that process for running management commands is a pain, we recommend