From 7d427d17c177f4b06886f32a30b26ff8d0a7df7d Mon Sep 17 00:00:00 2001 From: "Shashank S. Harivyasi" <45761248+harivyasi@users.noreply.github.com> Date: Wed, 24 Apr 2024 11:54:54 +0000 Subject: [PATCH] Add warning about single user installations --- docs/eln/install_configure/ChemCLI.mdx | 2 +- docs/eln/install_configure/index.mdx | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/eln/install_configure/ChemCLI.mdx b/docs/eln/install_configure/ChemCLI.mdx index a71d82b6..8f451885 100644 --- a/docs/eln/install_configure/ChemCLI.mdx +++ b/docs/eln/install_configure/ChemCLI.mdx @@ -5,7 +5,7 @@ sidebar_position: 11 ChemCLI, short for Chemotion CLI, is a tool to help you manage Chemotion ELN on a machine. The goal is to make installation, maintenance and upgradation of (multiple instances of) Chemotion as easy as possible. -:::info Important Announcements +:::info[Important Announcements] 1. You must manually update the CLI for versions 0.2.11 and lower. To do so, go to [Releases](https://github.com/Chemotion/ChemCLI/releases) and download the required executable. See [Updating the Tool](#updating-the-tool) for more. diff --git a/docs/eln/install_configure/index.mdx b/docs/eln/install_configure/index.mdx index 5584da9b..927f89a6 100644 --- a/docs/eln/install_configure/index.mdx +++ b/docs/eln/install_configure/index.mdx @@ -31,6 +31,14 @@ Please use Chrome as browser for the Chemotion ELN and Repository. Installing the ELN makes it available on port 4000 (default location is `0.0.0.0:4000`) of the computer on which it is installed. To make it accessible on a domain name, e.g. `https://myeln.edu` or over a network requires you to setup proxy. Detailed instructions for this are system/network dependent (and beyond the scope of this documentation). However, some hints are provided [here](manual_install.mdx#setting-up-a-reverse-proxy). +:::warning[Single User Installation] + +The ELN is designed to be used by multiple users. This means that it is usually installed on a server computer that is then served on a domain name (see [FQDN](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) for more) across a lab/department/institution/university. While it possible to use the ELN as a single user on private computer, this is not encouraged given the limitations that may arise in relation to device integration, deploying email service, and data sharing etc. + +If you still wish to install Chemotion ELN on your private computer (especially for testing etc.), we highly recommend the use of [ChemCLI](install_configure/ChemCLI) to do so. If you do not provide a web-address during installation then the ELN should start running at http://localhost:4000 when you use the tool. + +::: + ## After Installation Please follow the configuration steps (see [here](install_configure/manual_install#network-configuration) and [here](install_configure/configuration) to personalize your installation and then perform a [system check](install_configure/system_check) to make sure that all features are working as intended.