diff --git a/docs/8.0/ayanova/docs/img/ops-install-linux-console-open.png b/docs/8.0/ayanova/docs/img/ops-install-linux-console-open.png index be5b847f..0a5a6aab 100644 Binary files a/docs/8.0/ayanova/docs/img/ops-install-linux-console-open.png and b/docs/8.0/ayanova/docs/img/ops-install-linux-console-open.png differ 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 3e871ca9..9edc8400 100644 --- a/docs/8.0/ayanova/docs/ops-install-linux-desktop.md +++ b/docs/8.0/ayanova/docs/ops-install-linux-desktop.md @@ -6,7 +6,9 @@ The "desktop" installation is appropriate for a single user of AyaNova on a Linu ## Linux distributions -These instructions were compiled and tested on an Ubuntu 21.10 Desktop OS however any Linux x64 distribution should work provided the ASP.NET Core framework can be installed to it, you may need to substitute your Linux distribution's package manager and shell equivalent to the Apt package manager and Bash shell script commands shown here. +These instructions were compiled and tested on an Ubuntu 21.10 Desktop OS however any Linux x64 distribution should work provided the ASP.NET Core framework can be installed to it. + +You may need to "translate" these instructions into your Linux distribution's package manager and shell equivalent to the Apt package manager and Bash shell script commands shown here. ## System requirements @@ -71,19 +73,19 @@ 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. -### 4\. Create folders for AyaNova +### 4\. Create directorys for AyaNova -AyaNova requires two folders to be created, one to hold the AyaNova binary and other AyaNova 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. +AyaNova requires two directorys to be created, one to hold the AyaNova binary and other AyaNova 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. 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. +Create the data directory, for desktop linux we recommend your user home directory and AyaNova defaults to '~/.ayanova-data' in it's configuration, however you can use any location that you have write access to. ```bash sudo mkdir ~/.ayanova-data ``` -Create the AyaNova binary files folder. For desktop linux we recommend `/opt/ayanova`. +Create the AyaNova binary files directory. For desktop linux we recommend `/opt/ayanova`. ```bash sudo mkdir /opt/ayanova @@ -93,7 +95,7 @@ sudo mkdir /opt/ayanova The following shell script will automatically download and unzip the latest AyaNova files then start the server. -You *must* have the Curl and Unzip utilities installed before running this command. +You _must_ have the Curl and Unzip utilities installed before running this command. From a terminal window run the following commands: @@ -101,59 +103,16 @@ From a terminal window run the following commands: cd /opt/ayanova && \ sudo curl -O https://www.ayanova.com/download/ayanova-linux-x64-desktop.zip && \ sudo unzip -o ayanova-linux-x64-desktop.zip && \ -sudo chmod 777 ./AyaNova && \ -sudo ./AyaNova +sudo chmod 777 ./AyaNova ``` If there is an issue or error break apart the commands and execute each one individually to find the error. -AyaNova server should start with the final command. - - -The AyaNova binaries are located here: -[https://www.ayanova.com/download/ayanova-linux-x64-desktop.zip](https://www.ayanova.com/download/ayanova-linux-x64-desktop.zip) - -While you can download with a browser and move the files we strongly recommend using the Linux Curl utility instead so that you can download from the terminal. - -Install Curl if not already installed: - -```bash -sudo apt install curl -``` - -Using curl utility: - -```bash -sudo curl -O https://www.ayanova.com/download/ayanova-linux-x64-desktop.zip -``` - -Download the AyaNova server binary files to the folder created in the previous step or copy it there from the terminal: - -```bash -sudo cp ayanova-linux-x64-desktop.zip /opt/ayanova/ -``` - -### Unzip the archive - -Unzip the archive into the AyaNova server binary files folder created in the previous step. - -```bash -sudo unzip ayanova-linux-x64-desktop.zip -``` - -### Set execute permission - -From the terminal in the AyaNova binary files folder: - -```bash -sudo chmod 777 ./AyaNova -``` - -### Server configuration +### 6\. Configure server The server **must** be configured before it will be able to start properly and find the database server. -The AyaNova bin folder has a `config.json` file which is AyaNova's initial source for [configuration settings](ops-config-environment-variables.md) required for the server to start. It is necessary to edit this file (or provide an [alternative source of configuration](ops-config-environment-variables.md) and specify the password to connect to the PostgreSQL server. For example, if editing the default config.json file: +The AyaNova bin directory has a `config.json` file which is AyaNova's initial source for [configuration settings](ops-config-environment-variables.md) required for the server to start. It is necessary to edit this file (or provide an [alternative source of configuration](ops-config-environment-variables.md) and specify the password to connect to the PostgreSQL server. For example, if editing the default config.json file: ```json { @@ -177,11 +136,9 @@ 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 +### 7\. Boot and test AyaNova server -Start the server from the AyaNova bin folder in a terminal windows (ctrl-alt-t) - -(Note: you must be **in** the AyaNova folder for AyaNova server to start without error `/opt/ayanova/`) +Start AyaNova from a terminal window (ctrl-alt-t) _in_ the AyaNova server files directory `/opt/ayanova/`. AyaNova will _not_ start if you attempt to run it from another directory. ```bash sudo ./AyaNova @@ -193,18 +150,26 @@ If all is well then the console window will display "BOOT: COMPLETED - SERVER OP ![AyaNova server console running](img/ops-install-linux-console-open.png) -### Login to AyaNova web app +### 8\. Login to AyaNova web app 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://localhost:7575](http://localhost:7575). +You should see the license page once only as this is the first time opening this database, then, after agreement, the normal login page: + +![SCREENSHOT OF WEBPAGE LOGIN](img/ops-install-ayanovaloginpage.png) + +**Installation is now completed.** + ## 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. Alternatively you can hard shut down AyaNova using the ctrl-c key combination in the terminal console window where AyaNova is running however this is not recommended. -To start the server from a terminal follow the [boot](#boot-and-test-ayanova-server) instructions above. +To start the server from a terminal: -To start the server from +```bash +sudo ./AyaNova +``` ## Report rendering first time delay diff --git a/docs/8.0/ayanova/docs/ops-install-linux-server.md b/docs/8.0/ayanova/docs/ops-install-linux-server.md index 6ea20d4e..0d24f16b 100644 --- a/docs/8.0/ayanova/docs/ops-install-linux-server.md +++ b/docs/8.0/ayanova/docs/ops-install-linux-server.md @@ -118,23 +118,23 @@ libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget ``` -### 6\. Create folders for AyaNova +### 6\. Create directories for AyaNova -AyaNova requires several folders to be created: the AyaNova binary and other server and web application files, AyaNova data and the .local-chromium folder to contain a local copy of the Chromium browser for report rendering. +AyaNova requires several directories to be created: the AyaNova binary and other server and web application files, AyaNova data and the .local-chromium directory to contain a local copy of the Chromium browser for report rendering. -Create the AyaNova binary files folder. We recommend `/var/ayanova`: +Create the AyaNova binary files directory. We recommend `/var/ayanova`: ```bash sudo mkdir /var/ayanova ``` -Create the data folder. We recommend and AyaNova defaults to '/var/ayanova/data' in it's configuration: +Create the data directory. We recommend and AyaNova defaults to '/var/ayanova/data' in it's configuration: ```bash sudo mkdir /var/ayanova/data ``` -Create the .local-chromium folder: +Create the .local-chromium directory: ```bash sudo mkdir /var/ayanova/.local-chromium @@ -160,7 +160,7 @@ If there is an issue or error break apart the commands and execute each one indi The server **must** be configured before it will be able to start properly and find the database server. -The AyaNova bin folder has a `config.json` file which is AyaNova's initial source for [configuration settings](ops-config-environment-variables.md) required for the server to start. It is necessary to edit this file (or provide an [alternative source of configuration](ops-config-environment-variables.md) and specify the password to connect to the PostgreSQL server. For example, if editing the default config.json file: +The AyaNova bin directory has a `config.json` file which is AyaNova's initial source for [configuration settings](ops-config-environment-variables.md) required for the server to start. It is necessary to edit this file (or provide an [alternative source of configuration](ops-config-environment-variables.md) and specify the password to connect to the PostgreSQL server. For example, if editing the default config.json file: ```json { @@ -198,19 +198,19 @@ Make changes and save with `ctr-x` and type `y` to answer "Save modified buffer? AyaNova will be assumed for these instructions to run as `www-data`. -Give www-data ownership of the ayanova folder: +Give www-data ownership of the ayanova directory: ```bash sudo chown -vR :www-data /var/ayanova ``` -Set permissions to read / write for the AyaNova data folder: +Set permissions to read / write for the AyaNova data directory: ```bash sudo chmod -R g+rw /var/ayanova/data ``` -Set permissions to read / write / execute for the .local-chromium folder: +Set permissions to read / write / execute for the .local-chromium directory: ```bash sudo chmod -R g+rwx /var/ayanova/.local-chromium @@ -407,13 +407,13 @@ server { If this is a **new install dedicated to AyaNova only** and no existing NGINX services or websites will be impacted then replace the `default` NGINX configuration file as follows: -Switch to the NGINX configuration folder: +Switch to the NGINX configuration directory: ```bash cd /etc/nginx/sites-available ``` -Make a backup copy of the existing `default` config file to your HOME folder just in case: +Make a backup copy of the existing `default` config file to your HOME directory just in case: ```bash cp /etc/nginx/sites-available/default ~/nginx-default-backup diff --git a/docs/8.0/ayanova/docs/ops-upgrade-linux-desktop.md b/docs/8.0/ayanova/docs/ops-upgrade-linux-desktop.md index 798c1663..7314698f 100644 --- a/docs/8.0/ayanova/docs/ops-upgrade-linux-desktop.md +++ b/docs/8.0/ayanova/docs/ops-upgrade-linux-desktop.md @@ -2,6 +2,8 @@ The linux desktop upgrade process involves replacing the AyaNova program files with the latest version and restarting the AyaNova server. +These instructions assume the installation instructions were followed without changes, if you had to make changes adjust accordingly. + ### 1\. Backup Before proceeding, [make a backup](ops-form-backup.md) of the database **and** the attachment files and store it in a safe place. diff --git a/docs/8.0/ayanova/docs/ops-upgrade-linux-server.md b/docs/8.0/ayanova/docs/ops-upgrade-linux-server.md index 55c97da4..5eefd43d 100644 --- a/docs/8.0/ayanova/docs/ops-upgrade-linux-server.md +++ b/docs/8.0/ayanova/docs/ops-upgrade-linux-server.md @@ -1,9 +1,34 @@ -# AyaNova linux platform upgrade +# AyaNova linux server platform upgrade -The linux upgrade process involves replacing the AyaNova program files with the latest version and restarting the AyaNova server. +The linux server upgrade process involves replacing the AyaNova program files with the latest version and restarting the AyaNova server. -The following commands should be run from the shell in the AyaNova server folder. +These instructions assume the installation instructions were followed without changes, if you had to make changes adjust accordingly. + +### 1\. Backup + +Before proceeding, [make a backup](ops-form-backup.md) of the database **and** the attachment files and store it in a safe place. + +If you do not have a fresh backup there will be no way to recover from potential data loss or damage. + +### 2\. Upgrade + +The following shell script will automatically stop the AyaNova server service, remove the old AyaNova files, download and unzip the latest AyaNova files then start the server service. + +Run the following shell commands: ```bash -sudo curl -O https://www.ayanova.com/download/ayanova-linux-x64-server.zip -``` \ No newline at end of file +cd /var/ayanova && \ +sudo systemctl stop ayanova.service && \ +sudo curl -O https://www.ayanova.com/download/ayanova-linux-x64-server.zip && \ +sudo rm *.dll && \ +sudo rm -r ./resource && \ +sudo rm -r ./wwwroot && \ +sudo unzip -o ayanova-linux-x64-server.zip -x "config.json" && \ +sudo systemctl start ayanova.service +``` + +If there is an issue or error break apart the commands and execute each one individually to find the error. + +AyaNova should restart on it's own and perform any database schema updates if required automatically. + +Open the login form in your browser and after a short delay you should see the new version number at the bottom of the login form. diff --git a/docs/8.0/ayanova/mkdocs.yml b/docs/8.0/ayanova/mkdocs.yml index ff352ef0..adbaab68 100644 --- a/docs/8.0/ayanova/mkdocs.yml +++ b/docs/8.0/ayanova/mkdocs.yml @@ -133,6 +133,8 @@ nav: - 'Linux server': 'ops-install-linux-server.md' - Upgrade: - 'Start': 'ops-upgrade.md' + - 'Linux desktop': 'ops-upgrade-linux-desktop.md' + - 'Linux server': 'ops-upgrade-linux-server.md' - Migration: - 'Migrating from AyaNova 7': 'ops-import-v7.md' - Backup & Restore: