Skip to content

Commit

Permalink
Updated documentation and updated config for rabbitmq.
Browse files Browse the repository at this point in the history
  • Loading branch information
ucswift committed Feb 29, 2020
1 parent e53bfe3 commit bfa31b4
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Core/Resgrid.Config/ResgridConfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@
"WorkerConfig.PayloadKey": "XsBYpdbdHkhuGsU3tvTMawyV6d3M2F8EQ8wQ2jVLBREECQmwngACk2hm4Ykb7eW7Qsm6za8RdJBY5Z3xvN6erYry47nJ5XmL",

"ServiceBusConfig.RabbitHostname": "localhost",
"ServiceBusConfig.RabbitUsername": "guest",
"ServiceBusConfig.RabbbitPassword": "guest",
"ServiceBusConfig.RabbitUsername": "resgrid",
"ServiceBusConfig.RabbbitPassword": "resgrid!",
"ServiceBusConfig.RabbbitExchange": "",
"ServiceBusConfig.SignalRServiceBusConnectionString": "",
"ServiceBusConfig.SignalRTopicName": "",
Expand Down
26 changes: 26 additions & 0 deletions docs/source/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The following server dependencies need to be installed, configured and functiona

* `.Net Framework <https://dotnet.microsoft.com/download/visual-studio-sdks?utm_source=getdotnetsdk&utm_medium=referral>`_ .NET Framework 4.7.2 (Developer Pack)
* `.Net Core <https://dotnet.microsoft.com/download/visual-studio-sdks?utm_source=getdotnetsdk&utm_medium=referral>`_ .NET Core 1.1 (Runtime for your architecture x86 or x64)
* `Erlang <https://www.erlang.org/downloads>`_, needed for RabbitMQ
* `RabbitMQ Server <https://www.rabbitmq.com>`_, version 3.6.0 or newer
* `Microsoft SQL Server <https://www.microsoft.com/en-us/sql-server/default.aspx>`_, version 12.0 (SQL 2014) or newer
* `Microsoft IIS <https://www.iis.net/>`_ version installed on Windows 8 or newer or Windows Server 2012 or newer
Expand All @@ -34,6 +35,31 @@ To install RabbitMQ follow the `Windows Installation <https://www.rabbitmq.com/i

.. note:: RabbitMQ requires Erlang to be installed. You can download the `Windows installer <https://www.erlang.org/downloads>`_ at their website.

You will need to grant Erl and Epmd access to the network if your using the Windows firewall.

.. image:: https://raw.githubusercontent.com/resgrid/core/master/misc/images/RabbitMQFirewall.png
:width: 1100
:alt: Firewall Options for Erl and Epmd

Once RabbitMQ is installed and setup, and the Admin console is installed you will need to create the following user:

| Username: resgrid
| Password: resgrid!
.. image:: https://raw.githubusercontent.com/resgrid/core/master/misc/images/RabbitMQUserSetup.png
:width: 1100
:alt: RabbitMQ User setup

Once the user is setup you need to edit the "/" virtual host and grant permissions to that user to virtual host and topics.

.. image:: https://raw.githubusercontent.com/resgrid/core/master/misc/images/RabbitMQVHost.png
:width: 1100
:alt: RabbitMQ Virtual Host

You'll want .*, for all regexp values for both Virtual Host and Topic Permissions.

.. warning:: Once your system is setup and you've verified it working we highly creating a new username and password for Resgrid to use for RabbitMQ.

Redis
=======================

Expand Down
16 changes: 16 additions & 0 deletions docs/source/updating/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#######
Updating
#######

This section covers how to update, or upgrade, and existing installation of Resgrid.

.. important:: You should take backups of your Resgrid installation and database's before performing an upgrade. We recommend storing those backups off the server you are working on, for example on another server or storage location.

.. warning:: You cannot reverse an upgrade once it's been performed!

Getting the new version
****************************

Download the latest stable release from the `Resgrid Core Github Releases <https://github.com/Resgrid/Core/releases>`_ page. Pre-release or Beta versions will also be available for download but should not be used in production systems. Instead should only be used for testing or evaluating new features or functionality.

Extract the zip file to a temporary location.
Binary file added misc/images/RabbitMQFirewall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added misc/images/RabbitMQUserSetup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added misc/images/RabbitMQVHost.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bfa31b4

Please sign in to comment.