You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/installation/index.rst
+165-1Lines changed: 165 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,14 +40,178 @@ Redis is an standalone, resilient in memory data store that Redis uses to cache
40
40
41
41
..important::Although Redis is optional, it's recommended for production installations or multi server installations of Resgrid.
42
42
43
+
Elastic ELK
44
+
=======================
45
+
46
+
To install ELK from Elastic follow the `Elasticsearch MSI Installer<https://www.elastic.co/guide/en/elasticsearch/reference/6.6/windows.html>`_ and the Kilbana `Install Instructions<https://www.elastic.co/guide/en/kibana/6.6/windows.html>`_. You don't need Logstash as Resgrid can log directly to Elasticsearch. When installing Elasticsearch ensure it's port is externally accessible.
47
+
48
+
Microsoft IIS
49
+
=======================
50
+
51
+
Installing Microsoft IIS (Webserver) will differ based on what version of Windows you are using; for example Windows 8 or Windows Server 2016. For you specific version of Windows
52
+
53
+
..list-table::IIS Options
54
+
:header-rows: 1
55
+
56
+
* - Section
57
+
- Sub Section
58
+
- Option
59
+
* - Web Management Tools
60
+
-
61
+
- IIS Management Console
62
+
* - World Wide Web Services
63
+
- Application Development Features
64
+
- .Net Extensibility 3.5
65
+
* - World Wide Web Services
66
+
- Application Development Features
67
+
- .Net Extensibility 4.7
68
+
* - World Wide Web Services
69
+
- Application Development Features
70
+
- ASP.NET 3.5
71
+
* - World Wide Web Services
72
+
- Application Development Features
73
+
- ASP.NET 4.7
74
+
* - World Wide Web Services
75
+
- Application Development Features
76
+
- ISAPI Extensions
77
+
* - World Wide Web Services
78
+
- Application Development Features
79
+
- ISAPI Filters
80
+
* - World Wide Web Services
81
+
- Common HTTP Features
82
+
- Default Document
83
+
* - World Wide Web Services
84
+
- Common HTTP Features
85
+
- HTTP Errors
86
+
* - World Wide Web Services
87
+
- Common HTTP Features
88
+
- HTTP Redirection
89
+
* - World Wide Web Services
90
+
- Common HTTP Features
91
+
- Static Content
92
+
* - World Wide Web Services
93
+
- Performance Features
94
+
- Dynamic Content Compression
95
+
* - World Wide Web Services
96
+
- Performance Features
97
+
- Static Content Compression
98
+
* - World Wide Web Services
99
+
- Security
100
+
- Basic Authentication
101
+
* - World Wide Web Services
102
+
- Security
103
+
- IP Security
104
+
105
+
..note::Depending on the requirements of your web server, environment and other factors your installed IIS options may be different. Resgrid requires at a minimum the .NET Extensibility and ASP.NET Options to run minimally.
106
+
107
+
Install Resgrid
108
+
****************************
109
+
110
+
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.
111
+
112
+
Once you've download the release package extract the zip folder to your computer. It will reveal the directory structure in the table below.
113
+
114
+
..list-table::Resgrid Folder Structure
115
+
:header-rows: 1
116
+
117
+
* - Folder
118
+
- Description
119
+
* - Api
120
+
- Resgrid.Services API web application that will need to be exposed via IIS
121
+
* - Config
122
+
- Contains the ResgridConfig.json document to configure the Resgrid system
123
+
* - Tools
124
+
- Various tools, both UI and CLI to interact with Resgrid from the server
125
+
* - Web
126
+
- The primary Resgrid web application that will need to be exposed via IIS
127
+
* - Workers
128
+
- Backend workers to enable processing of async and scheduled tasks
129
+
130
+
The default installation location for Resgrid is C:\Resgrid, with the Api, Config, Tools, Web and Workers folder underneath that. So the full path to the config file is C:\Resgrid\Config\ResgridConfig.json. You can install Resgrid wherever you want, but you will need to update each application's config file (app.config, web.config or appsettings.json) with the correct path to the ResgridConfig.json file.
131
+
132
+
Create a new folder on your C:\Drive called "Resgrid" and copy the above 5 folders, that you extracted from the zip downloaded from Github, into that directory.
133
+
134
+
Setup Hosts File
135
+
=======================
136
+
137
+
Run Notepad as Administrator, open up the hosts file in the following directory 'C:\Windows\System32\drivers\etc' and add the following lines at the bottom.
138
+
139
+
127.0.0.1resgrid.local
140
+
127.0.0.1resgridapi.local
141
+
142
+
This will allow you to access locally on the box using the above domain names. If you have your own names you can use those in the IIS configuration below. If you already have the entries into your hosts file you do not need to add them again.
43
143
44
144
Database Installation
45
145
****************************
46
146
147
+
You will need to install and configure Microsoft SQL Server you can find tutorials online an example of one is `from tutorialpoint<https://www.tutorialspoint.com/ms_sql_server/ms_sql_server_installation.htm>`_. You will need SQL Server and SQL Managment Studio which can be `downloaded form Microsoft<https://docs.microsoft.com/en-us/sql/ssms/download-sql-server-management-studio-ssms?view=sql-server-2017>`_.
148
+
149
+
Once you have Microsoft SQL and Microsoft SQL Management Studio installed; open up Microsoft SQL Management studio, connect to your SQL Server and create an empty database called Resgrid.
150
+
151
+
Install\Update Resgrid Schema
152
+
=======================
153
+
154
+
Open up the Windows Command Prompt (cmd) and type:
155
+
156
+
cd C:\Resgrid\Tools\
157
+
158
+
your command prompt should now read "C:\Resgrid\Tools>". You can now type the following command into the command prompt:
159
+
160
+
Resgrid.Console.exe dbupdate
161
+
162
+
That will start the Resgrid Database Update process and either Update or Install your Resgrid database. If everything worked correctly you should see close to the following output:
163
+
164
+
C:\Resgrid\Tools>Resgrid.Console.exe dbupdate
165
+
Resgrid Console
166
+
-----------------------------------------
167
+
Starting the Resgrid Database Update Process
168
+
Please Wait...
169
+
Completed updating the Resgrid Database!
170
+
171
+
172
+
C:\Resgrid\Tools>
173
+
174
+
This will be run when your upgrading your Resgrid installation as well.
175
+
176
+
IIS Installation
177
+
****************************
178
+
179
+
Run the 'Internet Information Services (IIS) Manager' and expand the top server node and the Sites node in the tree view on the left hand side. If you don't have 2 sites called 'resgrid' and 'resgridapi' you will need to add those sites. Right click the Sites folder and select "Add Website"
180
+
181
+
..list-table::Resgrid Web Website Options
182
+
:header-rows: 1
183
+
184
+
* - Option
185
+
- Value
186
+
* - Site name
187
+
- resgrid
188
+
* - Physical path
189
+
- C:\Resgrid\Web
190
+
* - Binding Type
191
+
- https (Select from the drop-down)
192
+
* - Host name
193
+
- resgrid.local
194
+
* - SSL certificate
195
+
- *Select Any*
196
+
197
+
..list-table::Resgrid API Website Options
198
+
:header-rows: 1
199
+
200
+
* - Option
201
+
- Value
202
+
* - Site name
203
+
- resgridapi
204
+
* - Physical path
205
+
- C:\Resgrid\Api
206
+
* - Host name:
207
+
- resgridapi.local
208
+
209
+
..important::If you don't have a valid SSL certificate you can create a self-signed certificate by using `these instructions <https://aboutssl.org/how-to-create-a-self-signed-certificate-in-iis/>`_. You cannot use a self-signed certificate for the resgridapi IIS website as self-signed certificated will be rejected by the applications. We *HIGHLY* recommend you get valid SSL Certificates from a trusted vender and have both the resgrid and resgridapi protected by those.
47
210
211
+
..note::If you are using a Self Signed or Development SSL certificate you will get a Certificate Warning using any modern web browser. If your url is pointing to localhost,127.0.0.1,resgrid.local or resgridapi.local it is safe to proceed to the website and bypass that certificate error. We do not recommend doing that on public websites.
48
212
49
213
Initial Web Login
50
214
****************************
51
215
52
-
Once you have completed the steps above you will be able to log into the web applications user interface. Open up a web browser and navigate tohttp://resgrid.local, you will then be prompted by the login screen. Your default administrator credentials are **admin/changeme1234**. Once you log into the system it's recommended that you change your admin password from the Edit Profile page by clicking on the Administrator name in the upper left hand corner.
216
+
Once you have completed the steps above you will be able to log into the web applications user interface. Open up a web browser and navigate tohttps://resgrid.local, you will then be prompted by the login screen. Your default administrator credentials are **admin/changeme1234**. Once you log into the system it's recommended that you change your admin password from the Edit Profile page by clicking on the Administrator name in the upper left hand corner.