This commit is contained in:
@@ -28,7 +28,7 @@ Example command line log path parameter
|
||||
|
||||
`"dotnet run --AYANOVA_LOG_PATH=/home/gztw/Documents/temp/cmdlinelogs"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
## Log level
|
||||
|
||||
|
||||
@@ -30,4 +30,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_BACKUP_PG_DUMP_PATH="/usr/lib/postgresql/14.1/bin/"` (not real)
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -41,4 +41,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_DATA_PATH="/var/lib/ayanova"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -26,7 +26,6 @@ Linux:
|
||||
|
||||
`export AYANOVA_DB_CONNECTION="Server=localhost;Database=MyAyaNovaDB;"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
## Default database
|
||||
|
||||
|
||||
@@ -53,4 +53,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_DEFAULT_TRANSLATION="MyCustomTranslation"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -1,44 +1,89 @@
|
||||
# ENVIRONMENT VARIABLES / COMMAND LINE ARGUMENTS LIST
|
||||
# AYANOVA CONFIGURATION GUIDE
|
||||
|
||||
Most of the AyaNova configuration is stored inside the database, however anything related to starting the server can not be stored in the database and so environment variables or command line parameters are used to control server start up settings.
|
||||
Most of the AyaNova configuration is stored inside the database and set from within the AyaNova web application, however anything related to starting the server can not be stored in the database so external configuration is required for some settings.
|
||||
|
||||
These values can all be specified as an environment variable or as a command line parameter. In cases where both are specified, the command line parameter takes precedence.
|
||||
Configuration values can be specified in a `config.json` file in the AyaNova program files folder, an operating system environment variable or as a command line parameter to the AyaNova.exe server application. There are three sources of configuration available to support a wide range of scenarios and operating systems.
|
||||
|
||||
## DATABASE
|
||||
The AyaNova server looks for all three sources of configuration during startup and loads them in this order: config.json, environment variables, command line parameters. If any identical configuration settings are found in more than one of those sources the last one loaded wins. In other words the command line parameter has the highest precedence, environment variables second highest and and the config.json file has the lowest precedence.
|
||||
|
||||
No single source of configuration is _required_. Not all settings need to be specified; if any mandatory settings are mising AyaNova will report them in the application window / command line console if possible or to the IIS log if running in an IIS hosted configuration. In some cases it may be helpful for troubleshooting purposes to start AyaNova from the command line console "manually" to see the missing required settings.
|
||||
|
||||
While all three sources of configuration are valid to use together, we recommend sticking with one only to avoid confusion. Choose the method that is most appropriate for the situation keeping in mind security needs and ease of use. Once the server is up and running you can see which settings are in use by looking at the server log file which logs the settings in use when it boots or within the AyaNova web interface by logging in as an Operations role user and viewing the "Server settings" page.
|
||||
|
||||
Unless there is a specific need, it's generally easiest to use the `config.json` configuration file method.
|
||||
|
||||
## CONFIG.JSON
|
||||
|
||||
The first and lowest priority source of configuration settings that AyaNova looks for is the `config.json` file co-located with the `AyaNova.exe` executable. By default during installation this file is created in the AyaNova program files folder at `c:\Program Files\ayanova\`.
|
||||
|
||||
Here is an example config.json file contents, note that each property and value are quoted and comma separated and are required to be inside braces:
|
||||
|
||||
```json
|
||||
{
|
||||
"AYANOVA_USE_URLS": "http://*:7575",
|
||||
"AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=mypasswordforpostgres;Database=AyaNova;",
|
||||
"AYANOVA_DEFAULT_TRANSLATION": "en",
|
||||
"AYANOVA_BACKUP_PG_DUMP_PATH": "postgres\\bin\\",
|
||||
"AYANOVA_DATA_PATH": "%ProgramData%\\ayanova",
|
||||
"AYANOVA_LOG_LEVEL": "Info"
|
||||
}
|
||||
```
|
||||
|
||||
## ENVIRONMENT VARIABLES
|
||||
|
||||
Set the AyaNova environment variables in the manner appropriate for your operating system, either from the command line or as a host setting. For example:
|
||||
|
||||
Windows:
|
||||
|
||||
`set "AYANOVA_DB_CONNECTION=Server=localhost;Database=MyAyaNovaDB;"`
|
||||
|
||||
Linux:
|
||||
|
||||
`export AYANOVA_DB_CONNECTION="Server=localhost;Database=MyAyaNovaDB;"`
|
||||
|
||||
## COMMAND LINE PARAMETERS
|
||||
|
||||
Command line parameters are appended to the command to start the ayanova server, for example:
|
||||
|
||||
`AyaNova.exe --AYANOVA_DB_CONNECTION="Server=localhost;Username=postgres;Password=mypasswordforpostgres;Database=AyaNova;"`
|
||||
|
||||
## PARAMETERS AVAILABLE
|
||||
|
||||
### DATABASE
|
||||
|
||||
- [AYANOVA_DB_CONNECTION](ops-config-db.md)
|
||||
|
||||
## FILE STORAGE LOCATIONS
|
||||
### FILE STORAGE LOCATIONS
|
||||
|
||||
- [AYANOVA_DATA_PATH](ops-config-data-path.md)
|
||||
- [AYANOVA_BACKUP_FILES_PATH](ops-config-folder-backup-files.md)
|
||||
- [AYANOVA_ATTACHMENT_FILES_PATH](ops-config-folder-user-files.md)
|
||||
- [AYANOVA_TEMP_FILES_PATH](ops-config-folder-temporary-files.md)
|
||||
|
||||
## BACKUP UTILITY "pg_dump" PATH
|
||||
### BACKUP UTILITY "pg_dump" PATH
|
||||
|
||||
- [AYANOVA_BACKUP_PG_DUMP_PATH](ops-config-backup-pgdump-path.md)
|
||||
|
||||
|
||||
## LOGGING
|
||||
### LOGGING
|
||||
|
||||
- [AYANOVA_LOG_ENABLE_LOGGER_DIAGNOSTIC_LOG](common-log.md#troubleshooting-logging)
|
||||
- [AYANOVA_LOG_LEVEL](common-log.md#log-level)
|
||||
- [AYANOVA_LOG_PATH](common-log.md#log-path)
|
||||
|
||||
## TRANSLATION
|
||||
### TRANSLATION
|
||||
|
||||
- [AYANOVA_DEFAULT_TRANSLATION](ops-config-default-translation.md)
|
||||
|
||||
## API
|
||||
### API
|
||||
|
||||
- [AYANOVA_JWT_SECRET](ops-config-jwt-secret.md)
|
||||
- [AYANOVA_USE_URLS](ops-config-use-urls.md)
|
||||
|
||||
## REPORTING
|
||||
### REPORTING
|
||||
|
||||
- [AYANOVA_REPORT_RENDERING_TIMEOUT](ops-config-report-rendering-timeout.md)
|
||||
- [AYANOVA_REPORT_RENDERING_MAX_INSTANCES](ops-config-report-rendering-max-instances.md)
|
||||
|
||||
## SECURITY
|
||||
### SECURITY
|
||||
|
||||
- [AYANOVA_SET_SUPERUSER_PW](ops-config-set-superuser-pw.md)
|
||||
- [AYANOVA_SET_SUPERUSER_PW](ops-config-set-superuser-pw.md)
|
||||
|
||||
@@ -31,4 +31,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_BACKUP_FILES_PATH="/var/lib/ayanova/backupfiles"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -31,4 +31,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_TEMP_FILES_PATH="/var/lib/ayanova/tempfiles"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -32,4 +32,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_ATTACHMENT_FILES_PATH="/var/lib/ayanova/attachments"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -43,4 +43,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_JWT_SECRET="02847This_is_my_secret_key456576"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -52,4 +52,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_REPORT_RENDERING_MAX_INSTANCES="5"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -53,4 +53,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_REPORT_RENDERING_TIMEOUT="120000"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -32,4 +32,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_SET_SUPERUSER_PW="Th3RainInSpainFallsMainlyOnTh3Pla1n"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -33,4 +33,4 @@ Linux / MAC
|
||||
|
||||
`export AYANOVA_USE_URLS="http://*:5000"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
|
||||
|
||||
@@ -1,4 +1,34 @@
|
||||
# AYANOVA SERVER WINDOWS LAN INSTALLATION
|
||||
# AYANOVA INSTALLATION - LOCAL NETWORK DIRECT ACCESS INSTALL GUIDE
|
||||
|
||||
This installer includes the AyaNova server application only and requires a PostgreSQL server be installed or accessible and the .net Core framework to be installed separately first. Once the AyaNova server is up and running users on a local area network can access it with their web browsers pointed to the address of the AyaNova server.
|
||||
|
||||
This type of installation is *not* suitable for outside internet access, local network only.
|
||||
|
||||
|
||||
## System requirements
|
||||
|
||||
- OS : Windows 64 bit operating system
|
||||
- Internet connection : required to install license and to automatically download the Chromium report rendering engine on installation
|
||||
- Disk space: minimum 400mb of free disk space
|
||||
- RAM : 512 MB (minimum), 1 GB (recommended)
|
||||
|
||||
|
||||
## Folders
|
||||
|
||||
- Program files : By default (and recommended) AyaNova server program files will be installed to `C:\Program Files\ayanova` folder
|
||||
- Data files: By default AyaNova will store attachment files, logs and backup files in the %ProgramData% folder under `ayanova` which on most computers will be located at `C:\ProgramData\ayanova`. Each folder location can be changed by changing the configuration.
|
||||
|
||||
## Installation steps
|
||||
|
||||
- Download and run the standalone installer from our web site: [https://www.ayanova.com/Downloads/v8/ayanova-single-setup.exe](https://www.ayanova.com/Downloads/v8/ayanova-single-setup.exe). Follow the prompts and accept the defaults. At the end of setup the ayanova-launcher application will start if selected (or you can run it from the desktop icon) and in turn it will start the Postgres server, AyaNova server and then open the default web browser to both the AyaNova server interface and the AyaNova User interface.
|
||||
|
||||
## Starting and stopping AyaNova server
|
||||
To shut down the AyaNova server press the ctrl-c key combination in the ayanova-launcher window.
|
||||
To start the AyaNova server use the installed desktop or start menu icon to run the ayanova-launcher.
|
||||
|
||||
## Getting started and using AyaNova
|
||||
The next step is to follow the [getting started](adm-getting-started.md) guide for using and administrating AyaNova from a business point of view and also the [operations maintenance](ops-maintenance.md) guide to ensure AyaNova runs smoothly and data is safe and secure.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AYANOVA INSTALLATION FOR SINGLE WINDOWS USER
|
||||
# AYANOVA INSTALLATION - SINGLE WINDOWS USER GUIDE
|
||||
|
||||
The "single" installation is appropriate for a single user of AyaNova on a Windows 64 bit computer.
|
||||
|
||||
|
||||
@@ -1,12 +1,61 @@
|
||||
# AYANOVA SERVER WINDOWS INSTALLATION
|
||||
# AYANOVA WINDOWS INSTALLATION
|
||||
|
||||
Choose how AyaNova will be used for specific Windows installation instructions:
|
||||
Choose how AyaNova will be used for specific Windows installation instructions. Note that it's possible to switch to an alternative configuration via backup and restore if needs change later however if there is a possibility that AyaNova will be accessed from the internet it's recommended to install as an IIS hosted application.
|
||||
|
||||
- [Single user Windows computer](ops-install-windows-single.md)
|
||||
- [Windows server with local office network users only](ops-install-windows-lan.md)
|
||||
- [Windows server with local office and external internet users](ops-install-windows-internet.md)
|
||||
## Single user installation
|
||||
|
||||
## Windows hosting
|
||||
If you are using a Windows hosting provider with shell access follow the [Server with local office and external internet users](ops-install-windows-internet.md) guide
|
||||
This type of install is appropriate for using AyaNova locally on a single personal computer only. This type of installation is _not_ appropriate for sharing with multiple users.
|
||||
|
||||
[Single user install guide](ops-install-windows-single.md)
|
||||
|
||||
## Shared multiple user installation
|
||||
|
||||
When more than one user will be accessing AyaNova it can be set up in two different ways.
|
||||
|
||||
### AyaNova server direct
|
||||
|
||||
AyaNova running alone and access directly by users within a local office network.
|
||||
|
||||
This type of install is appropriate for use within a local area network _only_. It is _not_ suitable for sharing with outside users from the Internet.
|
||||
|
||||
Pros:
|
||||
|
||||
- Simpler to install
|
||||
- Does not require IIS
|
||||
|
||||
Cons:
|
||||
|
||||
- Server Windows computer must be kept logged in to run AyaNova server as a desktop application
|
||||
- AyaNova server application will not automatically restart if it's closed on the desktop
|
||||
- Not suitable for sharing with users / Customers outside the local area network via the internet
|
||||
|
||||
[Local network direct access install guide](ops-install-windows-lan.md)
|
||||
|
||||
AyaNova server in this configurataion is run as a desktop application on a computer that is accessible to other users w
|
||||
|
||||
### AyaNova server hosted through IIS (recommended)
|
||||
|
||||
AyaNova hosted via Microsoft Internet Information Server that is included with most editions of Windows.
|
||||
|
||||
This type of install is the most future proof and appropriate for users who access AyaNova from the Internet in addition to local users accessing via a local area network.
|
||||
|
||||
Pros:
|
||||
|
||||
- IIS manages AyaNova and ensures it stays running and will restart if necessary
|
||||
- Secured via IIS for remote users and optionally Customers on the Internet
|
||||
- Can use an SSL certificate in IIS which ensures all communications are encrypted between remote users and the AyaNova server
|
||||
- A true **server** configuration; IIS server will start AyaNova automatically without the need to login to Windows
|
||||
|
||||
Cons:
|
||||
|
||||
- Requires IIS to be enabled in Windows and some manual steps to configure IIS to use AyaNova
|
||||
|
||||
[Internet access via IIS install guide](ops-install-windows-internet.md)
|
||||
|
||||
AyaNova server in this configurataion is run as a desktop application on a computer that is accessible to other users w
|
||||
|
||||
## Off-premise Windows hosting
|
||||
|
||||
If a Windows hosting provider is being used with shell access follow the [Internet access via IIS install guide](ops-install-windows-internet.md) guide.
|
||||
|
||||
(note that a Linux hosting provider can be used and is generally recommended over Windows hosting purely for financial reasons, there is no practical difference from a technical standpoint between Linux or Windows hosted AyaNova)
|
||||
|
||||
Reference in New Issue
Block a user