diff --git a/docs/8.0/ayanova/docs/ops-install-linux.md b/docs/8.0/ayanova/docs/ops-install-linux.md index ae0d45a4..f0bb8086 100644 --- a/docs/8.0/ayanova/docs/ops-install-linux.md +++ b/docs/8.0/ayanova/docs/ops-install-linux.md @@ -1,29 +1,61 @@ # 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 Docker or NGINX methods. + +## Single user desktop installation + +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 install guide](ops-install-linux-desktop.md) + +## 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. + +### Local area network + +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 ################################ -todo: error rendering needs fix: -{"error":{"code":"2030","message":"Access to the path '/usr/bin/ayanova/~/.ayanova-data/temp/u5xaufhyksh.pdf' is denied."}} -config.json is: -{ - "AYANOVA_USE_URLS": "http://*:7575", - "AYANOVA_DB_CONNECTION":"Server=localhost;Username=postgres;Password=letmein;Database=AyaNova;", - "AYANOVA_DEFAULT_TRANSLATION":"en", - "AYANOVA_DATA_PATH":"~/.ayanova-data", - "AYANOVA_LOG_LEVEL": "Info" -} - - - - 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 +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 @@ -42,7 +74,7 @@ Linux DESKTOP standalone ubuntu desktop - - Make AyaNova AYANOVA_DATA_PATH folder, default expected is: ~/.ayanova-data + - 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 @@ -54,38 +86,38 @@ Linux DESKTOP standalone ubuntu desktop - 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 chmod 777 ./AyaNova + + - edit config.json sudo nano config.json - change "mypasswordforpostgres" in AYANOVA_DB_CONNECTION to the password set for postgres above + change "mypasswordforpostgres" 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 +local network //############################################################# nginx lan ubuntu - internet - +internet ############################################################### //DOCKER - https://www.ayanova.com/Downloads/v8/ayanova-linux-docker-x64-server.zip - +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 - \ No newline at end of file +lo.ExecutablePath = ServerBootConfig.AYANOVA_REPORT_RENDER_BROWSER_PATH;//"/usr/bin/chromium-browser";//this is the default path for docker based alpine dist diff --git a/docs/8.0/ayanova/docs/ops-install-windows.md b/docs/8.0/ayanova/docs/ops-install-windows.md index 7a8150af..879a5594 100644 --- a/docs/8.0/ayanova/docs/ops-install-windows.md +++ b/docs/8.0/ayanova/docs/ops-install-windows.md @@ -12,7 +12,7 @@ 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 in two different ways on a Windows server. -### Local area network +### Local area network AyaNova server running alone and access directly by users within a local office network. @@ -31,8 +31,6 @@ Cons: [Local area network install guide](ops-install-windows-lan.md) -AyaNova server in this configurataion is run as a desktop application on a computer that is accessible to other users w - ### AyaNova server hosted through IIS (recommended) AyaNova hosted via Microsoft Internet Information Server that is included with most editions of Windows. @@ -52,8 +50,6 @@ Cons: [IIS hosted AyaNova server install guide](ops-install-windows-iis.md) -AyaNova server in this configurataion is run as a desktop application on a computer that is accessible to other users w - ## Off-premise Windows hosting If a Windows hosting provider with shell access will be used follow the [Internet access via IIS install guide](ops-install-windows-iis.md) guide.