mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 05:23:35 +00:00
Fix a bunch of Zulip Voyager related comments.
(imported from commit 176e875cbc310ba00d6137930ddb718bd68f1866)
This commit is contained in:
@@ -30,15 +30,12 @@ file is as follows:
|
||||
[api]
|
||||
key=<api key from the web interface>
|
||||
email=<your email address>
|
||||
|
||||
If you are using Zulip Voyager, you should also add
|
||||
|
||||
site=<your Zulip Voyager server's URI>
|
||||
site=<your Zulip server's URI>
|
||||
|
||||
Alternatively, you may explicitly use "--user" and "--api-key" in our
|
||||
examples, which is especially useful if you are running several bots
|
||||
which share a home directory. There is also a "--site" option for
|
||||
setting the Zulip Voyager server on the command line.
|
||||
setting the Zulip server on the command line.
|
||||
|
||||
You can obtain your Zulip API key, create bots, and manage bots all
|
||||
from your Zulip [settings page](https://zulip.com/#settings).
|
||||
|
||||
@@ -49,7 +49,7 @@ RESUME_FILE = "/var/tmp/zulip_asana.state"
|
||||
# When initially started, how many hours of messages to include.
|
||||
ASANA_INITIAL_HISTORY_HOURS = 1
|
||||
|
||||
# If you're using Zulip Voyager, set this to your Zulip Voyager server
|
||||
# Set this to your Zulip API server URI
|
||||
ZULIP_SITE = "https://api.zulip.com"
|
||||
|
||||
# If properly installed, the Zulip API should be in your import
|
||||
|
||||
@@ -41,7 +41,7 @@ ZULIP_STREAM_NAME = "basecamp"
|
||||
## path, but if not, set a custom path below
|
||||
ZULIP_API_PATH = None
|
||||
|
||||
# If you're using Zulip Voyager, set this to your Zulip Voyager server
|
||||
# Set this to your Zulip API server URI
|
||||
ZULIP_SITE = "https://api.zulip.com"
|
||||
|
||||
# If you wish to log to a file rather than stdout/stderr,
|
||||
|
||||
@@ -50,7 +50,7 @@ ZULIP_TICKETS_STREAM_NAME = "tickets"
|
||||
# path, but if not, set a custom path below
|
||||
ZULIP_API_PATH = None
|
||||
|
||||
# If you're using Zulip Voyager, set this to your Zulip Voyager server
|
||||
# Set this to your Zulip API server URI
|
||||
ZULIP_SITE = "https://api.zulip.com"
|
||||
|
||||
# If you wish to log to a file rather than stdout/stderr,
|
||||
|
||||
@@ -61,5 +61,5 @@ def format_commit_message(author, subject, commit_id):
|
||||
## path, but if not, set a custom path below
|
||||
ZULIP_API_PATH = None
|
||||
|
||||
# If you're using Zulip Voyager, set this to your Zulip Voyager server
|
||||
# Set this to your Zulip server's API URI
|
||||
ZULIP_SITE = "https://api.zulip.com"
|
||||
|
||||
@@ -53,5 +53,5 @@ def commit_notice_destination(path, commit):
|
||||
## path, but if not, set a custom path below
|
||||
ZULIP_API_PATH = None
|
||||
|
||||
# If you're using Zulip Voyager, set this to your Zulip Voyager server
|
||||
# Set this to your Zulip server's API URI
|
||||
ZULIP_SITE = "https://api.zulip.com"
|
||||
|
||||
@@ -47,5 +47,5 @@ TRAC_NOTIFY_FIELDS = ["description", "summary", "resolution", "comment", "owner"
|
||||
## path, but if not, set a custom path below
|
||||
ZULIP_API_PATH = None
|
||||
|
||||
# If you're using Zulip Voyager, set this to your Zulip Voyager server
|
||||
# Set this to your Zulip API server URI
|
||||
ZULIP_SITE = "https://api.zulip.com"
|
||||
|
||||
@@ -97,7 +97,7 @@ def generate_option_group(parser, prefix=''):
|
||||
group = optparse.OptionGroup(parser, 'Zulip API configuration')
|
||||
group.add_option('--%ssite' % (prefix,),
|
||||
dest="zulip_site",
|
||||
help="Zulip Voyager server URI (if using Zulip Voyager)",
|
||||
help="Zulip server URI",
|
||||
default=None)
|
||||
group.add_option('--%sapi-key' % (prefix,),
|
||||
dest="zulip_api_key",
|
||||
|
||||
@@ -63,7 +63,7 @@ def send_email_job(job):
|
||||
class Command(BaseCommand):
|
||||
help = """Deliver emails queued by various parts of Zulip (either for immediate sending or sending at a specified time).
|
||||
|
||||
Run this command under supervisor. We use Mandrill for our deploy; this is for Zulip Voyager deploys.
|
||||
Run this command under supervisor. We use Mandrill for zulip.com; this is for SMTP email delivery.
|
||||
|
||||
Usage: python manage.py deliver_email
|
||||
"""
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
"""
|
||||
Forward messages sent to the configured email gateway to Zulip.
|
||||
|
||||
At Zulip, messages to that address go to the Inbox of emailgateway@zulip.com.
|
||||
For zulip.com, messages to that address go to the Inbox of emailgateway@zulip.com.
|
||||
Zulip voyager configurations will differ.
|
||||
|
||||
Messages meant for Zulip have a special recipient form of
|
||||
|
||||
@@ -18,7 +18,7 @@ class Command(BaseCommand):
|
||||
(The number of currently overdue (by at least a minute) email jobs)
|
||||
|
||||
This is run as part of the nagios health check for the deliver_email command.
|
||||
Please note that this is only currently useful for Zulip Voyager deploys.
|
||||
Please note that this is only relevant to the SMTP-based email delivery (no Mandrill).
|
||||
|
||||
Usage: python manage.py print_email_delivery_backlog
|
||||
"""
|
||||
|
||||
@@ -32,8 +32,11 @@ DEVELOPMENT = not PRODUCTION
|
||||
ZULIP_COM_STAGING = PRODUCTION and config_file.get('machine', 'deploy_type') == 'zulip.com-staging'
|
||||
ZULIP_COM = PRODUCTION and config_file.get('machine', 'deploy_type') == 'zulip.com-prod'
|
||||
|
||||
# Voyager is a production zulip server that is not zulip.com or staging.zulip.com
|
||||
# VOYAGER is not ENTERPRISE.
|
||||
# Voyager is a production zulip server that is not zulip.com or
|
||||
# staging.zulip.com VOYAGER is the standalone all-on-one-server
|
||||
# production deployment model for based on the original Zulip
|
||||
# ENTERPRISE implementation. We expect most users of the open source
|
||||
# project will be using VOYAGER=True in production.
|
||||
VOYAGER = PRODUCTION and not ZULIP_COM and not ZULIP_COM_STAGING
|
||||
|
||||
secrets_file = ConfigParser.RawConfigParser()
|
||||
|
||||
Reference in New Issue
Block a user