This commit is contained in:
@@ -3,8 +3,6 @@
|
||||
Starting with version 8, AyaNova was completely re-written.
|
||||
Our goals in this were to make AyaNova easier to use, modernize aging code, take advantage of the latest technologies and move to a modern run on any device approach.
|
||||
|
||||
This page documents the changes most relevant to everyday users of AyaNova however there were also many other technical changes of interest to system administrators and installers which are documented in our [Technical changes from v7](ops-technical-changes-from-v7.md) page of this documentation.
|
||||
|
||||
## User interface changes from v7
|
||||
|
||||
AyaNova 7 had several different user interfaces: the main interface was a Windows desktop application and as optional add-on products we had several different web browser interfaces for varying levels of devices. Each web interface had a limited sub-set of the full features in the Windows application and required separate installation and configuration procedures.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# BACKUP UTILITY "pg_dump" PATH SETTING
|
||||
# Backup utility "pg_dump" path setting
|
||||
|
||||
This setting controls where AyaNova will find the PostgreSQL pg_dump utility used forautomated backups.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# DATA PATH SETTING
|
||||
# Data path setting
|
||||
|
||||
This setting controls where AyaNova stores it's data by default and is required to be present unless all other path related configuration settings are specified individually.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# DATABASE
|
||||
# Database
|
||||
|
||||
AyaNova uses [PostgreSQL](https://www.postgresql.org/) as it's database server in all configurations, no other database is supported.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# DEFAULT TRANSLATION SETTING
|
||||
# Default translation setting
|
||||
|
||||
This setting controls the default language for text displayed to users in the AyaNova user interface.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AYANOVA CONFIGURATION GUIDE
|
||||
# AyaNova configuration guide
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# BACKUP FILES FOLDER SETTING
|
||||
# Backup files folder setting
|
||||
|
||||
This setting controls where AyaNova stores backup and restore files used by the backup and restore features built into AyaNova.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# TEMPORARY SERVER FILES FOLDER SETTING
|
||||
# Temporary server files folder setting
|
||||
|
||||
This setting controls where AyaNova stores files temporarily while servicing requests such as report generation etc.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# ATTACHMENTS FOLDER SETTING
|
||||
# Attachments folder setting
|
||||
|
||||
This setting controls where AyaNova stores user uploaded files used by features that allow file attachment or uploads.
|
||||
AyaNova stores these files with special names calculated from their digital signature (checksum) in a subdirectory in the folder specified.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# REPORT RENDER BROWSER PATH SETTING
|
||||
# Report render browser path setting
|
||||
|
||||
This optional setting sets the _full_ path to the Chromium web browser executable that is used by AyaNova to render reports.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# SUPER USER PASSWORD OVERRIDE
|
||||
# SuperUser password override
|
||||
|
||||
In the event that the SuperUser password is lost it can be reset using this setting.
|
||||
Upon booting up the server will reset the current SuperUser User account password to this value.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# PORT / URL SETTING
|
||||
# Port / URL setting
|
||||
|
||||
You can control the port and URL that the AyaNova server will listen on via environment variable or command line parameter.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# SERVER ERROR CODES
|
||||
# Server error codes
|
||||
#b4beta (clean up, remove unused error codes check if any others missing)
|
||||
AyaNova will provide a server error code when an error arises.
|
||||
All AyaNova server error codes start with the letter E followed by a number in the range 1000-1999.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# OPERATIONS BACKUP FORM
|
||||
# Operations backup form
|
||||
|
||||
AyaNova can automatically back up to the local file system once per day at a selected time.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
## OVERVIEW
|
||||
# Migrating from AyaNova 7
|
||||
|
||||
This is the technical guide to the migration to v8 process.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AYANOVA INSTALLATION - LINUX DESKTOP
|
||||
# AyaNova installation - linux desktop
|
||||
|
||||
Please read through all the instructions below **before** proceeding with installation to be sure everything is available and ready.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AYANOVA INSTALLATION - LINUX SERVER
|
||||
# AyaNova installation - linux server
|
||||
|
||||
Please read through all the instructions below **before** proceeding with installation to be sure everything is available and ready.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AYANOVA LINUX INSTALLATION
|
||||
# AyaNova linux installation
|
||||
|
||||
Choose how AyaNova will be used for specific Linux 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 using the NGINX proxy server instructions below.
|
||||
|
||||
@@ -13,4 +13,3 @@ This type of install is appropriate for using AyaNova locally on a single person
|
||||
When more than one user will be accessing AyaNova it can be set up on a Linux server either on-premise or with a Linux hosting provider, for example [Digitalocean](https://www.digitalocean.com/) or [Linode](https://www.linode.com/) that provides full shell access to a virtual or physical server.
|
||||
|
||||
[Server install guide](ops-install-linux-server.md)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AYANOVA INSTALLATION - WINDOWS IIS HOSTED
|
||||
# AyaNova installation - Windows IIS hosted
|
||||
|
||||
Please read through all the instructions below **before** proceeding with installation to be sure everything is available and ready.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AYANOVA INSTALLATION - WINDOWS LOCAL NETWORK
|
||||
# AyaNova installation - Windows local network
|
||||
|
||||
Please read through all the instructions below **before** proceeding with installation to be sure everything is available and ready.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AYANOVA INSTALLATION - WINDOWS SINGLE
|
||||
# AyaNova installation - Windows single
|
||||
|
||||
Please read through all the instructions below **before** proceeding with installation to be sure everything is available and ready.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AYANOVA WINDOWS INSTALLATION
|
||||
# AyaNova Windows installation
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# AYANOVA SERVER INSTALLATION
|
||||
# AyaNova server installation
|
||||
|
||||
The AyaNova server will run on Windows or Linux.
|
||||
The AyaNova server can be installed on Windows or Linux.
|
||||
|
||||
Choose your operating system for specific instructions:
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AYANOVA SERVER OPERATIONS GUIDE
|
||||
# AyaNova server operations guide
|
||||
|
||||
## AyaNova system architecture
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# SERVER MAINTENANCE
|
||||
# Server maintenance
|
||||
|
||||
An AyaNova server should require very little ongoing maintenance, however there are a few things that need to be monitored on a regular basis.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# METRICS
|
||||
# Metrics
|
||||
|
||||
[under construction]
|
||||
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
# Migrating from AyaNova 7
|
||||
|
||||
#b4beta (already have this page in ops-import-v7.md need to figure out which to use what links and remove one)
|
||||
@@ -1,7 +0,0 @@
|
||||
# NOTIFICATION SETTINGS
|
||||
#b4beta (consolidate all notificatin ops stuff into one page, check links)
|
||||
## SMTP settings
|
||||
This form is used to configure SMTP mail server settings for notification purposes.
|
||||
|
||||
## Notify event delivery queue
|
||||
From the menu you can access the Notify event delivery queue which lists all the events that are in the queue for delivery and has an option to delete delivery items if they haven't gone out yet. This is only pending items, delivered (or failed delivery) items are logged separately and removed from the queue automatically.
|
||||
@@ -1,5 +1,5 @@
|
||||
# NOTIFICATION SYSTEM
|
||||
|
||||
# Notification system
|
||||
000000000000 todo: see bottom 000000000000000000000
|
||||
AyaNova has a built in notification system that alerts users to events of interest that occur in AyaNova.
|
||||
|
||||
## Types of notifications
|
||||
@@ -18,7 +18,7 @@ There are two methods of delivering notifications:
|
||||
|
||||
## Email delivery configuration
|
||||
|
||||
The in application delivery does not require any configuration however the SMTP delivery is required to be set up in the [Ops Notification settings](ops-notification-settings.md) form.
|
||||
The in application delivery does not require any configuration however the SMTP delivery is required to be set up in the [Ops Notification settings](ops-notification-system.md) form.
|
||||
|
||||
## Operations specific notification events
|
||||
|
||||
@@ -29,3 +29,14 @@ Operations users should subscribe to several key notifications related directly
|
||||
- ServerOperationsProblem - sent whenever the server encounters any unusual condition or error that could be critical for the continuing operation of the AyaNova server
|
||||
|
||||
These are in addition to the normal operations methods of monitoring the health and status of the server such as [server logs](ops-log.md), [metrics](ops-metrics.md), [job queue](ops-jobs.md) etc.
|
||||
|
||||
|
||||
00000000000000000
|
||||
TODO: consolidate the ops notification settings page to here:
|
||||
# NOTIFICATION SETTINGS
|
||||
#b4beta (consolidate all notificatin ops stuff into one page, check links)
|
||||
## SMTP settings
|
||||
This form is used to configure SMTP mail server settings for notification purposes.
|
||||
|
||||
## Notify event delivery queue
|
||||
From the menu you can access the Notify event delivery queue which lists all the events that are in the queue for delivery and has an option to delete delivery items if they haven't gone out yet. This is only pending items, delivered (or failed delivery) items are logged separately and removed from the queue automatically.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# RESTORE AYANOVA BACKUP
|
||||
# Restore from backup
|
||||
|
||||
Restoring an [AyaNova backup](ops-form-backup.md) is done manually through the operating system.
|
||||
|
||||
@@ -97,9 +97,8 @@ The restore will complete normally without any message if successful.
|
||||
AyaNova can be re-started at this point, for server type installations restart through the IIS 'site' in Windows or the Service in Linux. If using the desktop single Windows installation, stop the PostgreSQL started in the earlier restore step by typing `ctrl-c` in the PostgreSQL console window then start AyaNova from the desktop launcher as normally.
|
||||
|
||||
### Verify the data
|
||||
|
||||
- Verify database: login to AyaNova, check that the most recent data that should be in the database backup is present
|
||||
- Verify attachments: First examine the list of attachments that AyaNova knows about in the database by opening the Adminstration -> Attached files. This list shows the attachments that AyaNova *expects* not necessarily what is physically present so select an attachment listed to open the record that attachment is connected to and confirm the physical file is actually present by opening the file in the attachments area of the form. If the file won't open verify that the attachment files are restored to the attachments folder where AyaNova expects to find them and not in another folder or sub folder and check again and also verify it's not just an issue with that one attachment by checking or more other attachment files in the same way.
|
||||
- Verify attachments: First examine the list of attachments that AyaNova knows about in the database by opening the Adminstration -> Attached files. This list shows the attachments that AyaNova _expects_ not necessarily what is physically present so select an attachment listed to open the record that attachment is connected to and confirm the physical file is actually present by opening the file in the attachments area of the form. If the file won't open verify that the attachment files are restored to the attachments folder where AyaNova expects to find them and not in another folder or sub folder and check again and also verify it's not just an issue with that one attachment by checking or more other attachment files in the same way.
|
||||
|
||||
There is no need to shut down the server if the attachment files need to be moved to the correct folder.
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
# OPERATIONS INTRO Placeholder
|
||||
#b4beta (what links here, do we need it?)
|
||||
- docs link here to explain what the AyaNoav server is so start with a server section and explain client server aspects briefly in overview
|
||||
- Then go on to the basic sections of ops starting with installation then config and then ongoing maintenance and metrics etc
|
||||
@@ -131,7 +131,7 @@ nav:
|
||||
- 'Linux desktop': 'ops-install-linux-desktop.md'
|
||||
- 'Linux server': 'ops-install-linux-server.md'
|
||||
- Migration:
|
||||
- 'Migrating from AyaNova 7': 'ops-migration-from-7.md'
|
||||
- 'Migrating from AyaNova 7': 'ops-import-v7.md'
|
||||
- Backup & Restore:
|
||||
- 'Backup': 'ops-form-backup.md'
|
||||
- 'Restore': 'ops-restore.md'
|
||||
@@ -142,7 +142,7 @@ nav:
|
||||
- 'Server log': 'ops-log.md'
|
||||
- 'Server metrics': 'ops-metrics.md'
|
||||
- 'Profile': 'ops-profile.md'
|
||||
- 'Notification settings': 'ops-notification-settings.md'
|
||||
- 'Notification settings': 'ops-notification-system.md'
|
||||
- 'Backup': 'ops-form-backup.md'
|
||||
- Technical:
|
||||
- 'Maintenance': 'ops-maintenance.md'
|
||||
@@ -161,8 +161,7 @@ nav:
|
||||
- 'Security and JWT web tokens': 'ops-config-jwt-secret.md'
|
||||
- 'SuperUser password reset': 'ops-config-set-superuser-pw.md'
|
||||
- 'Server error codes': 'ops-error-codes.md'
|
||||
- 'Technical changes from v7': 'ops-technical-changes-from-v7.md'
|
||||
- 'Importing from older AyaNova': 'ops-import-v7.md'
|
||||
- 'Migrating from AyaNova 7': 'ops-import-v7.md'
|
||||
- 'Metrics': 'ops-metrics.md'
|
||||
- 'Notification system': 'ops-notification-system.md'
|
||||
- 'Notification queue': 'ops-notify-queue.md'
|
||||
|
||||
Reference in New Issue
Block a user