diff --git a/dist/assets/lan-install-config.json b/dist/assets/lan-install-config.json index 46b13858..979da662 100644 --- a/dist/assets/lan-install-config.json +++ b/dist/assets/lan-install-config.json @@ -1,6 +1,6 @@ { "AYANOVA_USE_URLS": "http://*:7575", - "AYANOVA_DB_CONNECTION":"Server=localhost;Username=postgres;Password=mypasswordforpostgres;Database=AyaNova;", + "AYANOVA_DB_CONNECTION":"Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;", "AYANOVA_DEFAULT_TRANSLATION":"en", "AYANOVA_BACKUP_PG_DUMP_PATH":"postgres\\bin\\", "AYANOVA_DATA_PATH":"%ProgramData%\\ayanova", diff --git a/dist/assets/linux-desktop/config.json b/dist/assets/linux-desktop/config.json index 4685ae76..235a81c7 100644 --- a/dist/assets/linux-desktop/config.json +++ b/dist/assets/linux-desktop/config.json @@ -1,6 +1,6 @@ { "AYANOVA_USE_URLS": "http://*:7575", - "AYANOVA_DB_CONNECTION":"Server=localhost;Username=postgres;Password=mypasswordforpostgres;Database=AyaNova;", + "AYANOVA_DB_CONNECTION":"Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;", "AYANOVA_DEFAULT_TRANSLATION":"en", "AYANOVA_DATA_PATH":"~/.ayanova-data", "AYANOVA_LOG_LEVEL": "Info" diff --git a/dist/assets/linux-server/config.json b/dist/assets/linux-server/config.json index 0e282da9..aad2060e 100644 --- a/dist/assets/linux-server/config.json +++ b/dist/assets/linux-server/config.json @@ -1,6 +1,6 @@ { "AYANOVA_USE_URLS": "http://*:7575", - "AYANOVA_DB_CONNECTION":"Server=localhost;Username=postgres;Password=mypasswordforpostgres;Database=AyaNova;", + "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" diff --git a/docs/8.0/ayanova/docs/index.md b/docs/8.0/ayanova/docs/index.md index 5a632661..5673667b 100644 --- a/docs/8.0/ayanova/docs/index.md +++ b/docs/8.0/ayanova/docs/index.md @@ -1,7 +1,6 @@ # WELCOME TO AYANOVA ![AyaNovaIcon](img/ayanovaicon60x60.png) ## About this documentation -Last updated: 2020-August-11 This manual has the following sections: diff --git a/docs/8.0/ayanova/docs/ops-config-environment-variables.md b/docs/8.0/ayanova/docs/ops-config-environment-variables.md index c55a6c10..b77bf583 100644 --- a/docs/8.0/ayanova/docs/ops-config-environment-variables.md +++ b/docs/8.0/ayanova/docs/ops-config-environment-variables.md @@ -21,7 +21,7 @@ Here is an example config.json file contents, note that each property and value ```json { "AYANOVA_USE_URLS": "http://*:7575", - "AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=mypasswordforpostgres;Database=AyaNova;", + "AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;", "AYANOVA_DEFAULT_TRANSLATION": "en", "AYANOVA_BACKUP_PG_DUMP_PATH": "postgres\\bin\\", "AYANOVA_DATA_PATH": "%ProgramData%\\ayanova", @@ -45,7 +45,7 @@ Linux: 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;"` +`AyaNova.exe --AYANOVA_DB_CONNECTION="Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;"` ## PARAMETERS AVAILABLE diff --git a/docs/8.0/ayanova/docs/ops-install-linux-desktop.md b/docs/8.0/ayanova/docs/ops-install-linux-desktop.md index e75f1973..51a4f804 100644 --- a/docs/8.0/ayanova/docs/ops-install-linux-desktop.md +++ b/docs/8.0/ayanova/docs/ops-install-linux-desktop.md @@ -19,7 +19,9 @@ These instructions were compiled and tested on an Ubuntu 21.10 Desktop OS howeve ### ASP.NET Core runtime AyaNova requires the ASP.NET Core runtime version 6.0 or newer. -Install the ASP.NET CORE runtime 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) +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 @@ -33,11 +35,19 @@ To install PostgreSQL directly start here [https://www.postgresql.org/download/l If you are installing a local copy of PostgreSQL for the first time to use with AyaNova a password will need to be set for access. If you have an existing PostgreSQL server then you can skip this step but will need the Postgre server password in a later step. -Open the terminal (ctrl-alt-t): -Type `sudo -u postgres psql` -This should open a postgres psql command window -Type `ALTER USER postgres PASSWORD 'YOUR_PASSWORD_HERE';` substituting your desired password here and be sure to make a note of it for later. -If successful psql will display "ALTER ROLE" in response and you can close the psql terminal by typing `\q` to quit. +Open a PostgreSQL psql console: + +```bash +sudo -u postgres psql +``` + +Set your desired password: + +```bash +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. ### Create folders for AyaNova @@ -46,27 +56,42 @@ AyaNova requires two folders to be created, one to hold the AyaNova binary and o From the terminal: Create the data folder, for desktop linux we recommend your user home folder and AyaNova defaults to '~/.ayanova-data' in it's configuration, however you can use any location that you have write access to. -Type `sudo mkdir ~/.ayanova-data` + +```bash +sudo mkdir ~/.ayanova-data +``` Create the AyaNova binary files folder. For desktop linux we recommend `/usr/bin/ayanova`. -Type `sudo mkdir /usr/bin/ayanova` + +```bash +sudo mkdir /usr/bin/ayanova +``` ### Download the AyaNova binaries archive [https://www.ayanova.com/Downloads/v8/ayanova-linux-x64-desktop.zip](https://www.ayanova.com/Downloads/v8/ayanova-linux-x64-desktop.zip) Download the the AyaNova server binary files folder created in the previous step or copy it there from the terminal: -`sudo cp ayanova-linux-x64-desktop.zip /usr/bin/ayanova/` + +```bash +sudo cp ayanova-linux-x64-desktop.zip /usr/bin/ayanova/ +``` ### Unzip the archive Unzip the archive into the AyaNova server binary files folder created in the previous step. -`sudo unzip ayanova-linux-x64-desktop.zip` + +```bash +sudo unzip ayanova-linux-x64-desktop.zip +``` ### Set execute permission From the terminal in the AyaNova binary files folder: -`sudo chmod 777 ./AyaNova` + +```bash +sudo chmod 777 ./AyaNova +``` ### Server configuration @@ -77,21 +102,24 @@ The AyaNova bin folder has a `config.json` file which is AyaNova's initial sourc ```json { "AYANOVA_USE_URLS": "http://*:7575", - "AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=mypasswordforpostgres;Database=AyaNova;", + "AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;", "AYANOVA_DEFAULT_TRANSLATION": "en", "AYANOVA_DATA_PATH": "~/.ayanova-data", "AYANOVA_LOG_LEVEL": "Info" } ``` -The `AYANOVA_DB_CONNECTION` property must be edited and where it has "mypasswordforpostgres" substitute the actual PostgreSQL password to be used that was previously set. If the database server is located on a different computer then the `Server=` connection string property must be set to the address of that computer. +The `AYANOVA_DB_CONNECTION` property must be edited and where it has "YOUR_PASSWORD_HERE" substitute the actual PostgreSQL password to be used that was previously set. If the database server is located on a different computer then the `Server=` connection string property must be set to the address of that computer. 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. ### Boot and test AyaNova server Start the server from the AyaNova bin folder in a terminal windows (ctrl-alt-t) -`./AyaNova' + +```bash +./AyaNova +``` You should see an output in the terminal that indicates the AyaNova server version and that it is booting. Any problems found that prevent boot up will be displayed here. diff --git a/docs/8.0/ayanova/docs/ops-install-linux-lan.md b/docs/8.0/ayanova/docs/ops-install-linux-lan.md index a202d9f2..45db7b5a 100644 --- a/docs/8.0/ayanova/docs/ops-install-linux-lan.md +++ b/docs/8.0/ayanova/docs/ops-install-linux-lan.md @@ -28,7 +28,9 @@ Any modern browser (not Internet Explorer) with Javascript enabled on any device ### ASP.NET Core runtime AyaNova requires the ASP.NET Core runtime version 6.0 or newer. -Install the ASP.NET CORE runtime 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) +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 @@ -42,9 +44,18 @@ To install PostgreSQL directly start here [https://www.postgresql.org/download/l If you are installing a local copy of PostgreSQL for the first time to use with AyaNova a password will need to be set for access. If you have an existing PostgreSQL server then you can skip this step but will need the Postgre server password in a later step. -Type `sudo -u postgres psql` -This should open a postgres psql command window -Type `ALTER USER postgres PASSWORD 'YOUR_PASSWORD_HERE';` substituting your desired password here and be sure to make a note of it for later. +Open a PostgreSQL psql console: + +```bash +sudo -u postgres psql +``` + +Set your desired password: + +```bash +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. ### Create folders for AyaNova @@ -52,31 +63,50 @@ If successful psql will display "ALTER ROLE" in response and you can close the p 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. Create the AyaNova binary files folder. For server linux we recommend `/var/ayanova`. -Type `sudo mkdir /var/ayanova` + +```bash +sudo mkdir /var/ayanova +``` Create the data folder, for server linux we recommend and AyaNova defaults to '/var/ayanova/data' in it's configuration. -Type `sudo mkdir /var/ayanova/data` +```bash +sudo mkdir /var/ayanova/data +``` ### Download the AyaNova binaries archive +Switch to the AyaNova binary folder + +```bash +cd /var/ayanova +``` + Download the AyaNova archive to the binary files folder created in the previous step. [https://www.ayanova.com/Downloads/v8/ayanova-linux-x64-server.zip](https://www.ayanova.com/Downloads/v8/ayanova-linux-x64-server.zip) Using curl utility: -`sudo curl -O https://www.ayanova.com/Downloads/v8/ayanova-linux-x64-server.zip` +```bash +sudo curl -O https://www.ayanova.com/Downloads/v8/ayanova-linux-x64-server.zip +``` ### Unzip the archive Unzip the archive into the AyaNova server binary files folder created in the previous step: -`sudo unzip ayanova-linux-x64-server.zip` + +```bash +sudo unzip ayanova-linux-x64-server.zip +``` ### Set execute permission In the AyaNova binary files folder: -`sudo chmod 777 ./AyaNova` + +```bash +sudo chmod 777 ./AyaNova +``` ### Server configuration @@ -86,22 +116,25 @@ The AyaNova bin folder has a `config.json` file which is AyaNova's initial sourc ```json { - "AYANOVA_USE_URLS": "http://*:7575", - "AYANOVA_DB_CONNECTION":"Server=localhost;Username=postgres;Password=mypasswordforpostgres;Database=AyaNova;", - "AYANOVA_DEFAULT_TRANSLATION":"en", - "AYANOVA_DATA_PATH":"/var/ayanova/data/", - "AYANOVA_LOG_LEVEL": "Info" + "AYANOVA_USE_URLS": "http://*:7575", + "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" } ``` -The `AYANOVA_DB_CONNECTION` property must be edited and where it has "mypasswordforpostgres" substitute the actual PostgreSQL password to be used that was previously set. If the database server is located on a different computer then the `Server=` connection string property must be set to the address of that computer. +The `AYANOVA_DB_CONNECTION` property must be edited and where it has "YOUR_PASSWORD_HERE" substitute the actual PostgreSQL password to be used that was previously set. If the database server is located on a different computer then the `Server=` connection string property must be set to the address of that computer. 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. ### Boot and test AyaNova server Start the server from the AyaNova bin folder -`sudo ./AyaNova' + +```bash +sudo ./AyaNova +``` You should see an output in the terminal that indicates the AyaNova server version and that it is booting. Any problems found that prevent boot up will be displayed here. @@ -128,23 +161,20 @@ 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 - - +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 diff --git a/docs/8.0/ayanova/docs/ops-install-linux.md b/docs/8.0/ayanova/docs/ops-install-linux.md index 02c3dd6f..ec367643 100644 --- a/docs/8.0/ayanova/docs/ops-install-linux.md +++ b/docs/8.0/ayanova/docs/ops-install-linux.md @@ -6,7 +6,7 @@ Choose how AyaNova will be used for specific Linux installation instructions. No 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 desktop isntall guide](ops-install-linux-desktop.md) +[Single user desktop install guide](ops-install-linux-desktop.md) ## Shared multiple user server installation @@ -95,7 +95,7 @@ SYSTEM REQUIREMENTS NOTE: painfully slow with 1gb, probably needs 2gb to work pr - edit config.json sudo nano config.json - change "mypasswordforpostgres" in AYANOVA_DB_CONNECTION to the password set for postgres above + change "YOUR_PASSWORD_HERE" in AYANOVA_DB_CONNECTION to the password set for postgres above set AYANOVA_DATA_PATH location if not using the default which is: ~/.ayanova-data start AyaNova: diff --git a/docs/8.0/ayanova/docs/ops-install-windows-iis.md b/docs/8.0/ayanova/docs/ops-install-windows-iis.md index 57e41b18..689d5749 100644 --- a/docs/8.0/ayanova/docs/ops-install-windows-iis.md +++ b/docs/8.0/ayanova/docs/ops-install-windows-iis.md @@ -114,7 +114,7 @@ The AyaNova installer will create a `config.json` file in it's program files fol ```json { "AYANOVA_USE_URLS": "http://*:7575", - "AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=mypasswordforpostgres;Database=AyaNova;", + "AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;", "AYANOVA_DEFAULT_TRANSLATION": "en", "AYANOVA_BACKUP_PG_DUMP_PATH": "postgres\\bin\\", "AYANOVA_DATA_PATH": "%ProgramData%\\ayanova", @@ -122,7 +122,7 @@ The AyaNova installer will create a `config.json` file in it's program files fol } ``` -The `AYANOVA_DB_CONNECTION` property must be edited and where it has "mypasswordforpostgres" substitute the actual PostgreSQL password to be used. If the database server is located on a different computer then the `Server=` connection string property must be set to the address of that computer. +The `AYANOVA_DB_CONNECTION` property must be edited and where it has "YOUR_PASSWORD_HERE" substitute the actual PostgreSQL password to be used. If the database server is located on a different computer then the `Server=` connection string property must be set to the address of that computer. The `AYANOVA_USE_URLS` property specifies which TCP / IP Port that AyaNova server should listen on for connections from IIS. 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. diff --git a/docs/8.0/ayanova/docs/ops-install-windows-lan.md b/docs/8.0/ayanova/docs/ops-install-windows-lan.md index 9c3644d3..9c38bf5f 100644 --- a/docs/8.0/ayanova/docs/ops-install-windows-lan.md +++ b/docs/8.0/ayanova/docs/ops-install-windows-lan.md @@ -54,7 +54,7 @@ The AyaNova installer will create a `config.json` file in it's program files fol ```json { "AYANOVA_USE_URLS": "http://*:7575", - "AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=mypasswordforpostgres;Database=AyaNova;", + "AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;", "AYANOVA_DEFAULT_TRANSLATION": "en", "AYANOVA_BACKUP_PG_DUMP_PATH": "postgres\\bin\\", "AYANOVA_DATA_PATH": "%ProgramData%\\ayanova", @@ -62,7 +62,7 @@ The AyaNova installer will create a `config.json` file in it's program files fol } ``` -The `AYANOVA_DB_CONNECTION` property must be edited and where it has "mypasswordforpostgres" substitute the actual PostgreSQL password to be used. If the database server is located on a different computer then the `Server=` connection string property must be set to the address of that computer. +The `AYANOVA_DB_CONNECTION` property must be edited and where it has "YOUR_PASSWORD_HERE" substitute the actual PostgreSQL password to be used. If the database server is located on a different computer then the `Server=` connection string property must be set to the address of that computer. 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.