install: Configure services during installation.

This commit is contained in:
Mateusz Mandera
2025-02-04 22:19:23 +08:00
committed by Tim Abbott
parent 68c3e86ffa
commit 0de58860dc
3 changed files with 197 additions and 9 deletions

View File

@@ -61,11 +61,23 @@ follows:
```bash
sudo -s # If not already root
./zulip-server-*/scripts/setup/install --certbot \
./zulip-server-*/scripts/setup/install --push-notifications --certbot \
--email=YOUR_EMAIL --hostname=YOUR_HOSTNAME
```
This takes a few minutes to run, as it installs Zulip's dependencies. It is
This command will immediately prompt you to agree to Zulip's [Terms of
Service][terms], so that your server can be registered for the [Mobile Push
Notification Service](mobile-push-notifications.md). To skip registering for
access to push notifications at this time, remove the `--push-notifications`
flag.
:::{note}
When registering for push notifications, you can configure whether your server
will submit aggregate usage statistics. See `--no-submit-usage-statistics`
[installer option](#installer-options) for details.
:::
The installer takes a few minutes to run, as it installs Zulip's dependencies. It is
designed to be idempotent: if the script fails, once you've corrected the cause
of the failure, you can just rerun the script. For more information, see
[installer details](deployment.md#zulip-installer-details) and
@@ -89,6 +101,24 @@ of the failure, you can just rerun the script. For more information, see
SSL certificate another way, it's easy to [provide it to
Zulip][doc-ssl-manual].
- `--push-notifications`/`--no-push-notifications`: With this option, the Zulip
installer registers your server for the [Mobile Push Notification
Service](mobile-push-notifications.md), and sets up the initial default
configuration. You will be immediately prompted to agree to the [Terms of
Service][terms], and your server will be registered at the end of the
installation process. You can learn more [about the
service](mobile-push-notifications.md) and why it's [necessary for push
notifications](mobile-push-notifications.md#why-a-push-notification-service-is-necessary).
- `--no-submit-usage-statistics`: If you enable push notifications, by default
your server will submit [basic
metadata](mobile-push-notifications.md#uploading-basic-metadata) (required for
billing and for determining free plan eligibility), as well as [aggregate
usage statistics](mobile-push-notifications.md#uploading-usage-statistics).
You can disable submitting usage statistics by passing this flag. If push
notifications are not enabled, no data will be submitted, so this flag is
redundant.
- `--self-signed-cert`: With this option, the Zulip installer
generates a self-signed SSL certificate for the server. This isn't
suitable for production use, but may be convenient for testing.
@@ -152,3 +182,4 @@ Learning more:
server.
[realm-admin-docs]: https://zulip.com/help/moving-to-zulip
[terms]: https://zulip.com/policies/terms

View File

@@ -15,15 +15,18 @@ mobile apps.
:::{important}
These instructions are for Zulip Server 9.0+. If you are running an older
version of Zulip ([check](https://zulip.com/help/view-zulip-version) if you are
unsure), see the [Zulip 8.x
documentation](https://zulip.readthedocs.io/en/8.4/production/mobile-push-notifications.html).
The Zulip Server 10.0+ [installer](install.md#step-2-install-zulip)
includes a `--push-notifications` flag that automates this
registration process.
These instructions apply to Zulip 9.0+. If you are running an older
version of Zulip ([check](https://zulip.com/help/view-zulip-version)
if you are unsure), see the [Zulip 8.x
documentation](https://zulip.readthedocs.io/en/8.4/production/mobile-push-notifications.html).
:::
You can enable the mobile push notification service for your Zulip server as
follows:
You can enable the mobile push notification service for your Zulip
server as follows:
1. Make sure your server has outgoing HTTPS access to the public Internet. If
that is restricted by a proxy, you will need to [configure Zulip to use your