Skip to content

README.md

Latest commit

 

History

History
123 lines (85 loc) · 4.71 KB

README.md

File metadata and controls

123 lines (85 loc) · 4.71 KB
Raw

Maven Test & Coverage upload Coverage Status semantic-release: angular

logo

Nanodash was previously called Nanobench. Nanodash is a client to browse and publish nanopublications.

Online Instances

You can use Nanodash by login in via ORCID in one of the online instances:

Local Installation

To use Nanodash locally, see the installation instructions with Docker.

Analytics

Nanodash supports privacy-friendly, cookie-free analytics via Umami. Analytics are disabled by default and can be enabled by pointing Nanodash at an existing Umami instance.

Docker / environment variables (recommended for server deployments) — add to your docker-compose.override.yml:

services:
  nanodash:
    environment:
      - NANODASH_UMAMI_SCRIPT_URL=https://your.umami.instance/script.js
      - NANODASH_UMAMI_WEBSITE_ID=your-umami-website-id

YAML preferences file (convenient for local development) — add to ~/.nanopub/nanodash-preferences.yml:

umamiScriptUrl: https://your.umami.instance/script.js
umamiWebsiteId: your-umami-website-id

When configured, Nanodash logs Umami analytics configured: <url> at startup to confirm the setting was picked up.

Privacy page

Every page's footer links a privacy notice. The built-in one at /privacy describes what the software does with personal data — the ORCID login, the signing key held server-side, and that publishing is public and permanent — but it can only name the operator of an instance if the deployment tells it who that is:

services:
  nanodash:
    environment:
      - NANODASH_PRIVACY_OPERATOR=Your Organisation, Some Street 1, 1234 Town, Country - you@example.org

Left unset, the page says the instance does not name its operator rather than implying something untrue. A deployment with legal pages of its own can point the footer at them instead, which leaves the built-in page unused:

      - NANODASH_PRIVACY_URL=https://example.org/privacy

Or in ~/.nanopub/nanodash-preferences.yml: privacyOperator, privacyUrl.

Site mode

An instance can present itself as the website of one space rather than as Nanodash: the space's page becomes the home page, the space is the context of everything, its name and logo replace Nanodash's, and links to what lies outside the space are plain links. Set the space, and optionally a name, a logo and a stylesheet:

services:
  nanodash:
    environment:
      - NANODASH_SITE_SPACE=https://w3id.org/spaces/my-space
      - NANODASH_SITE_NAME=My Space
      - NANODASH_SITE_LOGO=https://example.org/logo.svg
      - NANODASH_SITE_CSS=https://example.org/site.css

Or in ~/.nanopub/nanodash-preferences.yml: siteSpace, siteName, siteLogo, siteCss. See docs/site-views.md for what changes and what does not.

Screenshot

This screenshot of Nanodash is showing its publishing feature with auto-complete-powered forms generated from semantic templates:

screenshot of Nanodash showing the publishing feature

Tutorials

Check out this short Nanodash demo video.

This hands-on demo (slightly outdated) gives you a quick hands-on introduction into nanopublications via the Nanodash interface, including a video: Hands-on demo video

Contributing

Contributions are welcome! Please see the CONTRIBUTING file for details.

License

Copyright (C) 2022-2026 Knowledge Pixels

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.