This commit is contained in:
2021-12-09 18:57:30 +00:00
parent 881195bb25
commit 116e1647ac
5 changed files with 39 additions and 39 deletions

View File

@@ -5,4 +5,6 @@
"AYANOVA_BACKUP_PG_DUMP_PATH":"postgres\\bin\\",
"AYANOVA_DATA_PATH":"%ProgramData%\\ayanova",
"AYANOVA_LOG_LEVEL": "Info"
}
}

View File

@@ -3,5 +3,6 @@
"AYANOVA_DB_CONNECTION":"Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;",
"AYANOVA_DEFAULT_TRANSLATION":"en",
"AYANOVA_DATA_PATH":"/var/ayanova/data/",
"AYANOVA_LOG_LEVEL": "Info"
"AYANOVA_LOG_LEVEL": "Info",
"AYANOVA_REPORT_RENDER_BROWSER_PATH": "/usr/bin/chromium-browser"
}

View File

@@ -4,7 +4,7 @@ This optional setting sets the _full_ path to the Chromium web browser executabl
If not set, AyaNova will attempt to automatically download a copy of Chromium to a `.local-chromium` folder under the AyaNova executable folder on first report rendering.
This setting should be used only in cases where it's more appropriate to use a previously installed Chromium browser installation.
This setting is typically only required for Linux Server operating systems.
## Default
@@ -16,11 +16,11 @@ AyaNova expects the report rendering browser path to be provided by an environme
`AYANOVA_REPORT_RENDER_BROWSER_PATH`
The value specified should be a string containing a fully qualified file path to the pg_dump utility.
The value specified should be a string containing a fully qualified file path to the Chromium browser.
Example command line parameter
`ayanova.exe --AYANOVA_REPORT_RENDER_BROWSER_PATH="/snap/chromium/current/bin/chromium.desktop/chrome.exe"` )
`ayanova.exe --AYANOVA_REPORT_RENDER_BROWSER_PATH="/usr/bin/chromium-browser"` )
Example environment variable
@@ -30,4 +30,4 @@ Windows
Linux / MAC
`export AYANOVA_REPORT_RENDER_BROWSER_PATH="/snap/chromium/current/bin/chromium.desktop/chrome.exe"`
`export AYANOVA_REPORT_RENDER_BROWSER_PATH="/usr/bin/chromium-browser"`

View File

@@ -113,6 +113,14 @@ The `AYANOVA_DB_CONNECTION` property must be edited and where it has "YOUR_PASSW
The `AYANOVA_USE_URLS` property specifies which TCP / IP Port that AyaNova server should listen on for connections from web browsers. The default value is port 7575 which should be free in most cases, however if you need to use an alternate port due to conflict it must be set here. We recommend using the default 7575 to avoid current or future confusion or conflict with other servers that may be installed or present elsewhere on the network.
Edit the config.json file using Nano text editor:
```bash
sudo nano config.json
```
Make changes and save with `ctr-x` and type `y` to answer "Save modified buffer?" prompt.
### Boot and test AyaNova server
Start the server from the AyaNova bin folder in a terminal windows (ctrl-alt-t)

View File

@@ -25,14 +25,14 @@ Any modern browser (not Internet Explorer) with Javascript enabled on any device
## Installation procedure
### ASP.NET Core runtime
### Install ASP.NET Core runtime
AyaNova requires the ASP.NET Core runtime version 6.0 or newer.
Install the **"ASP.NET CORE RUNTIME"** (NOT SDK VERSION) using this guide for your specific OS [https://docs.microsoft.com/en-us/dotnet/core/install/linux](https://docs.microsoft.com/en-us/dotnet/core/install/linux)
There are three different versions of .net core listed, be sure you select the "ASP.NET Core Runtime" version.
### PostgreSQL server
### Install PostgreSQL server
AyaNova requires access to a PostgreSQL database server version 12 or newer. If you do not have a PostgreSQL server already available then it must be installed to a location visible to the AyaNova server (same computer or a local computer on the same network).
@@ -58,6 +58,14 @@ ALTER USER postgres PASSWORD 'YOUR_PASSWORD_HERE';
If successful psql will display "ALTER ROLE" in response and you can close the psql console by typing `\q` to quit.
### Install Chromium browser
AyaNova uses a "headless" Chromium browser to render report templates.
```bash
sudo apt-get install chromium-browser
```
### Create folders for AyaNova
AyaNova requires two folders to be created, one to hold the AyaNova binary and other server and web application files and one to hold the AyaNova data. AyaNova will need to write to both these locations so be sure you choose locations with appropriate permissions.
@@ -120,7 +128,8 @@ The AyaNova bin folder has a `config.json` file which is AyaNova's initial sourc
"AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;",
"AYANOVA_DEFAULT_TRANSLATION": "en",
"AYANOVA_DATA_PATH": "/var/ayanova/data/",
"AYANOVA_LOG_LEVEL": "Info"
"AYANOVA_LOG_LEVEL": "Info",
"AYANOVA_REPORT_RENDER_BROWSER_PATH": "/usr/bin/chromium-browser"
}
```
@@ -128,6 +137,16 @@ The `AYANOVA_DB_CONNECTION` property must be edited and where it has "YOUR_PASSW
The `AYANOVA_USE_URLS` property specifies which TCP / IP Port that AyaNova server should listen on for connections from web browsers. The default value is port 7575 which should be free in most cases, however if you need to use an alternate port due to conflict it must be set here. We recommend using the default 7575 to avoid current or future confusion or conflict with other servers that may be installed or present elsewhere on the network.
The `AYANOVA_REPORT_RENDER_BROWSER_PATH` property specifies the path to the Chromium browser previously installed. The default path _may_ need to be changed if reports do not render and Chromium can not be found at the default location.
Edit the config.json file using Nano text editor:
```bash
sudo nano config.json
```
Make changes and save with `ctr-x` and type `y` to answer "Save modified buffer?" prompt.
### Boot and test AyaNova server
Start the server from the AyaNova bin folder
@@ -146,36 +165,6 @@ If all is well then the console window will display "BOOT: COMPLETED - SERVER OP
Open your web browser and navigate to the AyaNova server URL. Assuming the default port of 7575 is in use then the URL would be http://YOUR_AYANOVA_SERVER_IP_ADDRESS:7575
### Report rendering issues
AyaNova uses a "headless" Chromium web browser instance for report rendering and will attempt to automatically download it when rendering the first report.
On server versions of Linux there may be missing libraries required for this process.
If you receive a popup error when rendering a report you can view it in the web app error log, from any main page in AyaNova select About AyaNova at the bottom of the context menu then select Log from the About page context menu to view a list of the most recent errors encountered in AyaNova web client.
A typical error indicating a missing library for Chromium may look like this:
"Failed to launch browser! /var/ayanova/.local-chromium/Linux-884014/chrome-linux/chrome: error while loading shared libraries: libatk-1.0.so.0: cannot open shared object file: No such file or directory"
This error indicates libatk will need to be installed.
Repeat this process for any missing libraries until report rendering works properly.
test@devtest:/var/ayanova$ ldd ./.local-chromium/Linux-884014/chrome-linux/chrome | grep not
libatk-1.0.so.0 => not found
libatk-bridge-2.0.so.0 => not found
libcups.so.2 => not found
libxkbcommon.so.0 => not found
libXcomposite.so.1 => not found
libXdamage.so.1 => not found
libXfixes.so.3 => not found
libXrandr.so.2 => not found
libgbm.so.1 => not found
libpango-1.0.so.0 => not found
libcairo.so.2 => not found
libatspi.so.0 => not found
libxshmfence.so.1 => not found
## Starting and stopping AyaNova server
To shut down the AyaNova server cleanly use the AyaNova web app form accessed from Server Operations -> Server State and the menu item Shut down server.