Zulip Documentation Release 1.4.0

Zulip Documentation Release 1.4.0

Zulip Documentation Release 1.4.0 The Zulip Team Feb 07, 2017 Overview 1 Zulip overview 3 1.1 Community................................................3 1.2 Installing the Zulip Development environment.............................4 1.3 Running Zulip in production.......................................4 1.4 Ways to contribute............................................4 1.5 Google Summer of Code.........................................4 1.6 How to get involved with contributing to Zulip.............................4 1.7 License..................................................5 2 Zulip architectural overview 7 2.1 Key Codebases..............................................7 2.2 Usage assumptions and concepts.....................................7 2.3 Components...............................................8 2.4 Glossary................................................. 11 3 Directory structure 13 3.1 Core Python files............................................. 13 3.2 HTML Templates............................................ 13 3.3 JavaScript and other static assets..................................... 14 3.4 Tests................................................... 14 3.5 Management commands......................................... 14 3.6 Scripts.................................................. 14 3.7 API and Bots............................................... 15 3.8 Production puppet configuration..................................... 15 3.9 Additional Django apps......................................... 15 3.10 Jinja2 Compatibility Files........................................ 15 3.11 Translation files............................................. 16 3.12 Documentation.............................................. 16 4 Zulip Roadmap 17 4.1 Introduction............................................... 17 4.2 Major projects.............................................. 17 4.3 Core User Experience.......................................... 18 4.4 Social features.............................................. 18 4.5 Real-time sync.............................................. 18 4.6 Onboarding issues............................................ 18 4.7 Production installation issues...................................... 19 i 4.8 Administration and management..................................... 19 4.9 Scalability and performance....................................... 19 4.10 Technology improvements........................................ 19 4.11 Technical Debt.............................................. 20 4.12 Security.................................................. 20 4.13 Testing.................................................. 20 4.14 Documentation.............................................. 20 4.15 Integrations and bots........................................... 20 4.16 Android app............................................... 21 4.17 iOS app.................................................. 21 4.18 Server/webapp support for mobile.................................... 21 4.19 Desktop apps............................................... 21 4.20 Community................................................ 21 5 Version History 23 5.1 Unreleased................................................ 23 5.2 1.5.0 – 2017-02-06............................................ 23 5.3 1.4.3 - 2017-01-29............................................ 26 5.4 1.4.2 - 2016-09-27............................................ 26 5.5 1.4.1 - 2016-09-03............................................ 26 5.6 1.4.0 - 2016-08-25............................................ 26 5.7 1.3.13 - 2016-06-21........................................... 29 5.8 1.3.12 - 2016-05-10........................................... 30 5.9 1.3.11 - 2016-05-02........................................... 30 5.10 1.3.10 - 2016-01-21........................................... 31 5.11 1.3.9 - 2015-11-16............................................ 31 5.12 1.3.8 - 2015-11-15............................................ 31 5.13 1.3.7 - 2015-10-19............................................ 32 6 Requirements 33 6.1 Server................................................... 33 6.2 Credentials needed............................................ 34 7 Production Installation 35 7.1 Step 0: Subscribe............................................. 35 7.2 Step 1: Install SSL Certificates...................................... 35 7.3 Step 2: Download and install latest release............................... 35 7.4 Step 3: Configure Zulip......................................... 36 7.5 Step 4: Initialize Zulip database..................................... 36 7.6 Step 5: Create a Zulip organization and login.............................. 36 7.7 Troubleshooting............................................. 37 8 Troubleshooting 39 8.1 Using supervisorctl............................................ 39 8.2 Troubleshooting services......................................... 41 9 Customize Zulip 43 9.1 Integrations................................................ 43 9.2 Streams and Topics............................................ 44 9.3 Notification settings........................................... 44 9.4 Mobile and desktop apps......................................... 44 9.5 All other features............................................. 44 9.6 Enjoy your Zulip installation!...................................... 44 10 Secure, maintain, and upgrade 47 ii 10.1 Upgrading................................................ 47 10.2 Upgrading from a git repository..................................... 49 10.3 Backups................................................. 49 10.4 Monitoring................................................ 51 10.5 Scalability................................................ 51 10.6 Securing your Zulip server........................................ 52 10.7 Management commands......................................... 52 11 Security Model 55 11.1 Secure your Zulip server like your email server............................. 55 11.2 Encryption and Authentication...................................... 55 11.3 Messages and History.......................................... 56 11.4 Users and Bots.............................................. 57 11.5 User-uploaded content.......................................... 57 11.6 Final notes and security response.................................... 58 12 Authentication methods 59 12.1 Adding additional methods using python-social-auth.......................... 59 12.2 Remote User SSO Authentication.................................... 60 13 Postgres database details 63 13.1 Remote Postgres database........................................ 63 13.2 Debugging postgres database issues................................... 64 13.3 Stopping the Zulip postgres database.................................. 64 13.4 Debugging issues starting postgres.................................... 64 13.5 Postgres Vacuuming alerts........................................ 65 14 Development environment installation 67 14.1 Requirements............................................... 67 14.2 Recommended setup (Vagrant)...................................... 67 14.3 Advanced setup (non-Vagrant)...................................... 67 14.4 Slow internet connections........................................ 68 14.5 Installing remotely............................................ 68 14.6 Next steps................................................ 68 15 Vagrant environment setup tutorial 69 15.1 Requirements............................................... 70 15.2 Step 1: Install Prerequisites....................................... 70 15.3 Step 2: Get Zulip Code.......................................... 72 15.4 Step 3: Start the development environment............................... 73 15.5 Step 4: Developing............................................ 75 15.6 Next Steps................................................ 77 15.7 Troubleshooting & Common Errors................................... 77 15.8 Specifying a proxy............................................ 82 16 Zulip development environment setup without Vagrant 83 16.1 Installing directly on Ubuntu....................................... 83 16.2 Installing manually on Linux....................................... 83 16.3 Using Docker (experimental)...................................... 89 17 Using the Development Environment 91 18 Developing on a remote machine 93 18.1 Connecting to the remote environment................................. 93 18.2 Setting up the development environment................................ 93 iii 18.3 Running the development server..................................... 94 18.4 Making changes to code on your remote development server...................... 94 19 Writing a new integration 99 19.1 Types of integrations........................................... 99 19.2 General advice.............................................. 100 19.3 Webhook integrations.......................................... 100 19.4 Python script and plugin integrations.................................. 101 19.5 Documenting your integration...................................... 102 19.6 Hello World webhook Walkthrough................................. 102 20 Writing a new application feature 109 20.1 General Process in brief......................................... 109 20.2 Example Feature............................................. 110 21 Writing views in Zulip 115 21.1 What this covers............................................. 115 21.2 What is a view?.............................................

View Full Text

Details

  • File Type
    pdf
  • Upload Time
    -
  • Content Languages
    English
  • Upload User
    Anonymous/Not logged-in
  • File Pages
    275 Page
  • File Size
    -

Download

Channel Download Status
Express Download Enable

Copyright

We respect the copyrights and intellectual property rights of all users. All uploaded documents are either original works of the uploader or authorized works of the rightful owners.

  • Not to be reproduced or distributed without explicit permission.
  • Not used for commercial purposes outside of approved use cases.
  • Not used to infringe on the rights of the original creators.
  • If you believe any content infringes your copyright, please contact us immediately.

Support

For help with questions, suggestions, or problems, please contact us