diff --git a/docs/ignore-paths.txt b/docs/ignore-paths.txt index 385b2cc80c..64bee4c24f 100644 --- a/docs/ignore-paths.txt +++ b/docs/ignore-paths.txt @@ -9,6 +9,7 @@ https://github.com/BlueBrain/nexus-js/blob/main/packages/nexus-link/README.md https://github.com/BlueBrain/nexus-js/blob/main/packages/nexus-sdk/README.md https://github.com/BlueBrain/nexus-js/blob/main/packages/react-nexus/README.md https://github.com/BlueBrain/nexus-web/blob/main/README.md.* +https://github.com/lightbend/config.* https://www.janelia.org http://mouselight.janelia.org/ http://ml-neuronbrowser.janelia.org diff --git a/docs/src/main/paradox/docs/delta/architecture.md b/docs/src/main/paradox/docs/delta/architecture.md index bf4abd3318..47a3a31965 100644 --- a/docs/src/main/paradox/docs/delta/architecture.md +++ b/docs/src/main/paradox/docs/delta/architecture.md @@ -193,7 +193,7 @@ The authorization flow is as follows: [Nexus Fusion]: ../fusion/index.md [Nexus Forge]: ../forge.md [PostgreSQL]: https://www.postgresql.org/ -[Elasticsearch]: https://www.elastic.co/elasticsearch/ +[Elasticsearch]: https://www.elastic.co/elasticsearch [Blazegraph]: https://blazegraph.com/ [cluster configuration]: https://github.com/BlueBrain/nexus/blob/$git.branch$/delta/app/src/main/resources/app.conf#L290 [CQRS]: https://martinfowler.com/bliki/CQRS.html diff --git a/docs/src/main/paradox/docs/fusion/architecture.md b/docs/src/main/paradox/docs/fusion/architecture.md index edb46b2d1b..4d120be96f 100644 --- a/docs/src/main/paradox/docs/fusion/architecture.md +++ b/docs/src/main/paradox/docs/fusion/architecture.md @@ -46,7 +46,7 @@ Customize the Nexus codebase appearance by setting environment variables. Defaul #### Landing Page Customization -- `LOGO_IMG`: HTTPS URL for the application logo. Recommended: SVG format with transparent background. Ideal size: ~35 px height, max 250 px width. @link:[Click here for an example SVG](https://github.com/BlueBrain/nexus-web/tree/main/src/shared/images/EPFL_BBP_logo.svg){ open=new }. +- `LOGO_IMG`: HTTPS URL for the application logo. Recommended: SVG format with transparent background. Ideal size: ~35 px height, max 250 px width. @link:[Click here for an example SVG](https://github.com/BlueBrain/nexus-web/blob/main/src/shared/images/EPFL_BBP_logo.svg){ open=new }. - `LOGO_LINK`: HTTPS URL redirecting from the logo. Example: - `LANDING_VIDEO`: HTTPS URL for a landing page video. Requirements: MP4 format, H.264 codec, ~10MB, 1920×1080 resolution. @link:[Click here for an example video](https://github.com/BlueBrain/nexus-web/tree/main/src/videos/BrainRegionsNexusPage.mp4){ open=new }. Ensure that the video's main color is not too bright, as the text on top of it will be white. - `LANDING_POSTER_IMG`: HTTPS URL for a loading image on the landing page, displayed while the video loads. @link:[Click here for an example poster image](https://github.com/BlueBrain/nexus-web/blob/main/src/shared/images/BrainRegionsNexusPage.jpg){ open=new }. Please use a PNG or JPG image that matches the size and color of the video. Aim for the image to have the same dimensions as the video. Ensure that the image size is kept under 200 KB to improve loading time and user experience. diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md b/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md index 255c58c2bd..1ee1a2f5be 100644 --- a/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md +++ b/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md @@ -6,7 +6,7 @@ There are 3 ways to modify the default configuration: - Setting the env variable `DELTA_EXTERNAL_CONF` which defines the path to a HOCON file. The configuration keys that are defined here can be overridden by the other methods. - Using JVM properties as arguments when running the service: -D`{property}`. For example: `-Dapp.http.interface="127.0.0.1"`. -- Using @link:[FORCE_CONFIG_{property}](https://github.com/lightbend/config#user-content-optional-system-or-env-variable-overrides){ open=new } +- Using @link:[FORCE_CONFIG_{property}](https://github.com/lightbend/config#optional-system-or-env-variable-overrides){ open=new } environment variables. In order to enable this style of configuration, the JVM property `-Dconfig.override_with_env_vars=true` needs to be set. Once set, a configuration flag can be overridden. For example: `CONFIG_FORCE_app_http_interface="127.0.0.1"`. diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/index.md b/docs/src/main/paradox/docs/getting-started/running-nexus/index.md index 4b1e342805..2780db7ce8 100644 --- a/docs/src/main/paradox/docs/getting-started/running-nexus/index.md +++ b/docs/src/main/paradox/docs/getting-started/running-nexus/index.md @@ -262,7 +262,7 @@ of throughput with various hardware configurations. When the usage profiles are should narrow the scope: 1. Nexus uses a collection of data stores (@link:[PostgreSQL](https://www.postgresql.org/){ open=new }, - @link:[Elasticsearch](https://www.elastic.co/elasticsearch/){ open=new }, + @link:[Elasticsearch](https://www.elastic.co/elasticsearch){ open=new }, @link:[Blazegraph](https://blazegraph.com/){ open=new }) which depend performance wise to the underlying disk access, so: * prefer local storage over network storage for lower latency when doing IO, @@ -302,7 +302,7 @@ implications to the total amount of disk used by the primary store. ### Elasticsearch -Nexus uses @link:[Elasticsearch](https://www.elastic.co/elasticsearch/){ open=new } to host several _system_ indices and _user +Nexus uses @link:[Elasticsearch](https://www.elastic.co/elasticsearch){ open=new } to host several _system_ indices and _user defined_ ones. It offers sharding and replication out of the box. Deciding whether this system requires backup depends on the tolerated time for a restore. Nexus can be instructed to rebuild all indices using the data from the _primary store_, but being an incremental indexing process it can take longer than restoring from a backup. Since it can be