Skip to content

Commit bfa31b4

Browse files
committed
Updated documentation and updated config for rabbitmq.
1 parent e53bfe3 commit bfa31b4

File tree

6 files changed

+44
-2
lines changed

6 files changed

+44
-2
lines changed

Core/Resgrid.Config/ResgridConfig.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
"WorkerConfig.PayloadKey": "XsBYpdbdHkhuGsU3tvTMawyV6d3M2F8EQ8wQ2jVLBREECQmwngACk2hm4Ykb7eW7Qsm6za8RdJBY5Z3xvN6erYry47nJ5XmL",
4848

4949
"ServiceBusConfig.RabbitHostname": "localhost",
50-
"ServiceBusConfig.RabbitUsername": "guest",
51-
"ServiceBusConfig.RabbbitPassword": "guest",
50+
"ServiceBusConfig.RabbitUsername": "resgrid",
51+
"ServiceBusConfig.RabbbitPassword": "resgrid!",
5252
"ServiceBusConfig.RabbbitExchange": "",
5353
"ServiceBusConfig.SignalRServiceBusConnectionString": "",
5454
"ServiceBusConfig.SignalRTopicName": "",

docs/source/installation/index.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The following server dependencies need to be installed, configured and functiona
1919

2020
* `.Net Framework <https://dotnet.microsoft.com/download/visual-studio-sdks?utm_source=getdotnetsdk&utm_medium=referral>`_ .NET Framework 4.7.2 (Developer Pack)
2121
* `.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)
22+
* `Erlang <https://www.erlang.org/downloads>`_, needed for RabbitMQ
2223
* `RabbitMQ Server <https://www.rabbitmq.com>`_, version 3.6.0 or newer
2324
* `Microsoft SQL Server <https://www.microsoft.com/en-us/sql-server/default.aspx>`_, version 12.0 (SQL 2014) or newer
2425
* `Microsoft IIS <https://www.iis.net/>`_ version installed on Windows 8 or newer or Windows Server 2012 or newer
@@ -34,6 +35,31 @@ To install RabbitMQ follow the `Windows Installation <https://www.rabbitmq.com/i
3435

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

38+
You will need to grant Erl and Epmd access to the network if your using the Windows firewall.
39+
40+
.. image:: https://raw.githubusercontent.com/resgrid/core/master/misc/images/RabbitMQFirewall.png
41+
:width: 1100
42+
:alt: Firewall Options for Erl and Epmd
43+
44+
Once RabbitMQ is installed and setup, and the Admin console is installed you will need to create the following user:
45+
46+
| Username: resgrid
47+
| Password: resgrid!
48+
49+
.. image:: https://raw.githubusercontent.com/resgrid/core/master/misc/images/RabbitMQUserSetup.png
50+
:width: 1100
51+
:alt: RabbitMQ User setup
52+
53+
Once the user is setup you need to edit the "/" virtual host and grant permissions to that user to virtual host and topics.
54+
55+
.. image:: https://raw.githubusercontent.com/resgrid/core/master/misc/images/RabbitMQVHost.png
56+
:width: 1100
57+
:alt: RabbitMQ Virtual Host
58+
59+
You'll want .*, for all regexp values for both Virtual Host and Topic Permissions.
60+
61+
.. 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.
62+
3763
Redis
3864
=======================
3965

docs/source/updating/index.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#######
2+
Updating
3+
#######
4+
5+
This section covers how to update, or upgrade, and existing installation of Resgrid.
6+
7+
.. 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.
8+
9+
.. warning:: You cannot reverse an upgrade once it's been performed!
10+
11+
Getting the new version
12+
****************************
13+
14+
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.
15+
16+
Extract the zip file to a temporary location.

misc/images/RabbitMQFirewall.png

60.4 KB
Loading

misc/images/RabbitMQUserSetup.png

37.2 KB
Loading

misc/images/RabbitMQVHost.png

36.5 KB
Loading

0 commit comments

Comments
 (0)