admin/raven
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Browse Source
This commit is contained in:
John Cardinal
2021-12-10 19:35:34 +00:00
parent 6363f444cc
commit 38dc58536f
7 changed files with 61 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/8.0/ayanova/docs/ops-install-linux-desktop.md
View File

@@ -1,5 +1,7 @@
# AYANOVA INSTALLATION - LINUX DESKTOP
Please read through all the instructions below **before** proceeding with installation to be sure everything is available and ready.
The "desktop" installation is appropriate for a single user of AyaNova on a Linux x64 Desktop OS computer accessed with local browser.
## Linux distributions

55
docs/8.0/ayanova/docs/ops-install-linux-lan.md → docs/8.0/ayanova/docs/ops-install-linux-server.md
View File

@@ -1,9 +1,14 @@
# AYANOVA INSTALLATION - LINUX LOCAL NETWORK
# AYANOVA INSTALLATION - LINUX SERVER
The "LOCAL NETWORK" installation is appropriate for use within a private office network.
This type of installation is _not_ suitable for outside internet access, for outside access use the [NGINX proxied AyaNova server install guide](ops-install-linux-nginx.md) instead.
Please read through all the instructions below **before** proceeding with installation to be sure everything is available and ready.
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.
These instructions assume shell access to a Linux server and a working knowledge of Linux adminstration tasks.
We also offer "Turnkey" solutions for AyaNova hosting, see our website at [AyaNova.com](https://ayanova.com) for details.
The "SERVER" installation configuration is appropriate for use both within a private office network or from the internet.
Once the AyaNova server is up and running users can access it with their web browsers pointed to the address of the AyaNova server.
No installation is required at the user end to access the AyaNova web app with a supported browser.
@@ -11,6 +16,10 @@ No installation is required at the user end to access the AyaNova web app with a
These instructions were compiled and tested on an Ubuntu 20 server OS however any Linux x64 distribution should work provided the ASP.NET Core framework can be installed to it.
## Hosted linux
There is no significant difference in setup between a linux server physically on premise or hosted from a hosting provider such as [Digitalocean](https://www.digitalocean.com/) or [Linode](https://www.linode.com/) with shell root access.
## AyaNova web app system requirements
Any modern browser (not Internet Explorer) with Javascript enabled on any device with a minimum display width of 360 pixels.
@@ -22,6 +31,8 @@ Any modern browser (not Internet Explorer) with Javascript enabled on any device
- Disk space: minimum 400mb of free disk space
- RAM : 512 MB (minimum), 1 GB (recommended)
- Modern web browser with Javascript enabled
- Static IP address if AyaNova will be used from the internet
- Domain or subdomain name if AyaNova will be used from the internet
## Installation procedure
@@ -33,7 +44,7 @@ Install the **"ASP.NET CORE RUNTIME"** (NOT SDK VERSION) using this guide for yo
There are three different versions of .net core listed, be sure you select the "ASP.NET Core Runtime" version.
NOTE: In the example command lines in the linked pages above they are sometimes missing the `sudo` command, be sure to add it before commands listed there.
NOTE: In the example command lines in the linked pages above they are sometimes missing the `sudo` command, be sure to add it before commands listed there if non root user.
### Install PostgreSQL server
@@ -76,7 +87,7 @@ ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils
### Create folders 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 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.
Create the AyaNova binary files folder. We recommend `/var/ayanova`:
@@ -227,7 +238,7 @@ Confirm the AyaNova service is running by viewing the service status:
sudo systemctl status ayanova.service
```
You should see in the status dislpay the AyaNova server version and that it is booting. Any problems found that prevent boot up will be displayed here.
You should see in the service status display the AyaNova server version and that it is booting. Any problems found that prevent boot up will be displayed here.
Note that the first boot of AyaNova may require a few seconds to fully open before you will see server open message below. If you view the status too soon you may not see it get to BOOT: COMPLETED yet, just quite `q` and show status again.
@@ -243,6 +254,36 @@ If you need to stop the AyaNova service:
sudo systemctl stop ayanova.service
```
### Local network access only
If users are accessing AyaNova only on a private local area network no more installation steps are required and it should be ready for use.
Assuming the default port of 7575 is in use then the URL would be http://YOUR_LOCAL_NETWORK_AYANOVA_SERVER_IP_ADDRESS:7575
If users will need to access AyaNova from the internet continue to the next step "Internet access" otherwise you can skip it and move on to "Getting started and using AyaNova" below.
## Internet access
If users will be accessing AyaNova from the internet a few extra requirements are necessary to ensure security.
The following items will be required to configure AyaNova on a linux server for internet access:
- Static IP address
- Registered domain name
- SSL certificate
- Reverse proxy server such as NGINX or Apache
For these instructions we will be using NGINX as the reverse proxy server.
### Static IP address
A static IP address is **required** to host AyaNova on the internet. If you have a virtual or physical server through a server hosting provider such as Digitalocean or Linode then you will already have a static IP address. If you are hosting your own server on premise on a private office network connecting to the internet via an Internet Service Provider you will need to ensure your ISP has provided you with a static IP address and if they haven't you will need to request a static IP address and have that address on hand before proceeding.
### Registered domain name
An internet domain name is required to get an SSL certificate for secure encrypted communications between the AyaNova server and the end user across the internet.
An entry will need to be made in your DNS record for your domain to provide a name to access the AyaNova server and it must point to the static IP address of your router or server. If the only service on your domain will be AyaNova then you can use the root domain name i.e. `example.com` or `www.example.com` but it's more common to use a subdomain specifically for AyaNova, i.e. `ayanova.example.com`.
This DNS record needs to be in place and active **before** proceeding and can take minutes to hours to propagate so be sure to do this as soon as possible.
### 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://YOUR_AYANOVA_SERVER_IP_ADDRESS:7575

111
docs/8.0/ayanova/docs/ops-install-linux.md
View File

@@ -10,114 +10,7 @@ This type of install is appropriate for using AyaNova locally on a single person
## Shared multiple user server installation
When more than one user will be accessing AyaNova it can be set up in two different ways on a Linux server either on-premise or with any Linux hosting provider such as DigitalOcean or Linode that provides full shell access to a virtual or physical server.
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 such as DigitalOcean or Linode that provides full shell access to a virtual or physical server.
### Local area network
[Server install guide](ops-install-linux.server.md)
AyaNova server 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:
- Does not require NGINX or an SSL certificate for in-office use / simpler to install
Cons:
- Not suitable for sharing with users / Customers outside the local area network via the internet
[Local area network install guide](ops-install-linux-lan.md)
### AyaNova server with NGINX proxy server
AyaNova behind an NGINX proxy server.
This type of install is appropriate for users who access AyaNova from the Internet in addition to local users accessing via a local area network.
Pros:
- Secured behind NGINX for remote users and optionally Customers on the Internet
- Uses an SSL certificate with NGINX which ensures all communications are encrypted between remote users and the AyaNova server
Cons:
- Requires NGINX and some manual steps to configure NGINX to work with AyaNova
- Requires PostgreSQL to be installed or available
[NGINX proxied AyaNova server install guide](ops-install-linux-nginx.md)
//##############################################################################################################################
GET WORKING MANUALLY THEN CAN DO DOCS ONCE HAVE PROCESS HERE
(expand the instructions on stack overflow pages and link to the pg and asp.net core install pages)
SPLIT THIS OUT INTO MULTIPLE PAGES LIKE WINDOWS
//#################################### LINUX DESKTOP ################################
Linux DESKTOP standalone ubuntu desktop
todo: put running on desktop image at top here
SYSTEM REQUIREMENTS NOTE: painfully slow with 1gb, probably needs 2gb to work properly
- Install ASP.NET CORE runtime using this guide: https://docs.microsoft.com/en-us/dotnet/core/install/linux
IF no postgreSQL already:
- Install postgreSQL https://www.postgresql.org/download/linux/ubuntu/
Note: the version that comes with even the newest ubuntu is 2 versions out of date so best to follow the install guide to directly install from pg
as it will auto-update and be the most recent secure version
- Set postgres password
https://stackoverflow.com/a/14588440
test@test-VirtualBox:~$ sudo -u postgres psql
psql (14.1 (Ubuntu 14.1-1.pgdg21.10+1))
Type "help" for help.
postgres=# ALTER USER postgres PASSWORD 'letmein';
ALTER ROLE
postgres-# \q
- Make AyaNova AYANOVA_DATA_PATH folder in your home folder, default expected is: ~/.ayanova-data
sudo mkdir ~/.ayanova-data
Note: You don't have to use this path but if you change it then this will be required to be set in a config file in a later step
- download ayanova linux x64 archive
https://www.ayanova.com/Downloads/v8/ayanova-linux-x64-desktop.zip
- Make program folder:
sudo mkdir /usr/bin/ayanova
- copy archive to program folder
sudo cp ayanova-linux-x64-desktop.zip /usr/bin/ayanova/
- Unzip the archive into an appropriate folder (/usr/bin/ayanova)
sudo unzip ayanova-linux-x64-desktop.zip
- Set permissions on AyaNova:
sudo chmod 777 ./AyaNova
- edit config.json
sudo nano config.json
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:
sudo ./AyaNova
Verify it's working
- open browser and navigate to http://localhost:7575/login (or whatever port was enabled)
//#############################################################
server lan ubuntu
local network
//#############################################################
nginx lan ubuntu
internet
###############################################################
//DOCKER
https://www.ayanova.com/Downloads/v8/ayanova-linux-docker-x64-server.zip
https://dotnetthoughts.net/how-to-nginx-reverse-proxy-with-docker-compose/
todo: this is not nearly enough, I need to make it fully working with NGINX containerized etc
I think maybe this is best left as a howto document instead of a built config
todo: Docker config add path to chromium in env variable:
lo.ExecutablePath = ServerBootConfig.AYANOVA_REPORT_RENDER_BROWSER_PATH;//"/usr/bin/chromium-browser";//this is the default path for docker based alpine dist

4
docs/8.0/ayanova/docs/ops-install-windows-iis.md
View File

@@ -1,5 +1,7 @@
# AYANOVA INSTALLATION - WINDOWS IIS HOSTED
Please read through all the instructions below **before** proceeding with installation to be sure everything is available and ready.
This installer includes the AyaNova server application only and depends on an IIS server, a PostgreSQL server be installed or accessible and the .net Core framework to be installed in the correct order (detailed below).
This type of installation is suitable for both outside internet access and inside the local network.
@@ -19,6 +21,8 @@ Any modern browser (not Internet Explorer) with Javascript enabled on any device
- RAM : 512 MB (minimum), 1 GB (recommended)
- PostgreSQL Server: installation guide [https://www.postgresqltutorial.com/install-postgresql/](https://www.postgresqltutorial.com/install-postgresql/)
- ASP.NET Core Runtime Hosting bundle v6.0.0 or newer : Download [https://dotnet.microsoft.com/permalink/dotnetcore-current-windows-runtime-bundle-installer](https://dotnet.microsoft.com/permalink/dotnetcore-current-windows-runtime-bundle-installer)
- Static IP address if AyaNova will be used from the internet
- Domain or subdomain name if AyaNova will be used from the internet
## Security and Network requirements to access IIS from the internet

2
docs/8.0/ayanova/docs/ops-install-windows-lan.md
View File

@@ -1,5 +1,7 @@
# AYANOVA INSTALLATION - WINDOWS LOCAL NETWORK
Please read through all the instructions below **before** proceeding with installation to be sure everything is available and ready.
Windows Local network installation is suitabale for use within a private office network.
This type of installation is _not_ suitable for outside internet access, for outside access use the [IIS hosted AyaNova server install guide](ops-install-windows-iis.md) instead.

2
docs/8.0/ayanova/docs/ops-install-windows-single.md
View File

@@ -1,5 +1,7 @@
# AYANOVA INSTALLATION - WINDOWS SINGLE
Please read through all the instructions below **before** proceeding with installation to be sure everything is available and ready.
The "single" installation is appropriate for a single user of AyaNova on a Windows 64 bit computer.
This installer includes everything needed to run AyaNova locally on a single computer; a standalone version of the Postgres sql server, the AyaNova server files and all .net core framework files required by AyaNova and the "ayanova-launcher" application which when run will automatically start a standalone Postgres server, then the AyaNova server and finally will launch the default browser to the AyaNova web application to login and start working.

2
docs/8.0/ayanova/mkdocs.yml
View File

@@ -131,7 +131,7 @@ nav:
- 'Windows IIS': 'ops-install-windows-iis.md'
- 'Linux': 'ops-install-linux.md'
- 'Linux desktop': 'ops-install-linux-desktop.md'
- 'Linux LAN': 'ops-install-linux-lan.md'
- 'Linux server': 'ops-install-linux.server.md'
- Forms:
- 'Introduction': 'ops-intro.md'
- 'Server state': 'ops-server-state.md'