Skip to content

Commit

Permalink
GH-1881 Improve dashboard guide
Browse files Browse the repository at this point in the history
* dashboard.md: adds descriptive links to TLA (three-letter abbreviation :) descriptions; fixes typos; beautifies language

* dashboard.md: corrects typo

* Corrects wording in dashboard.md

Co-authored-by: Joshua Sing <joshua@hypera.dev>

* dashboard.md: corrects link to proper CDN

---------

Co-authored-by: Joshua Sing <joshua@hypera.dev>
  • Loading branch information
gerib and joshuasing committed Aug 7, 2023
1 parent 68515c0 commit 40394a7
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions reposilite-site/data/guides/features/dashboard.md
Expand Up @@ -3,36 +3,33 @@ id: dashboard
title: Dashboard
---

Reposilite exposes frontend that is mounted to `/#/` as SPA application in Vue 3.
You can disable frontend in [shared configuration](/guide/settings#shared-configuration)
if you just want to disable an easy way to query your repository or to provide custom frontend implementation using [static files](/guide/static-files).
Reposilite exposes a frontend that is mounted to `/#/` as [SPA _(single-page application)_](https://en.wikipedia.org/wiki/Single-page_application) in [Vue 3](https://vuejs.org/). You can disable the frontend in [shared configuration](/guide/settings#shared-configuration) if you want to disable an easy way to query your repository or to provide a custom frontend implementation using [static files](/guide/static-files).

#### Browser
Browser displays content of currently selected directory, respectively to provided authentication credentials. For not logged user it lists only public files, for authenticated one it also displays files that user has access to.
Browser displays the content of the currently selected directory in respect to the provided authentication credentials. For users not logged in it lists only public files, for authenticated users it also displays files that the user has access to.

![Dashboard Browser Preview](/images/guides/dashboard-browser-preview.png)

You can control the way Reposilite displays directory content by opening adjustments view through the icon in right top corner:
You can control how Reposilite displays directory content by opening the adjustments view via the icon in the top-right corner:

![Browser Adjustments](/images/guides/dashboard-browser-adjustments.png)

#### Console

CLI *(command-line interface)* displays current Reposilite output and allows to perform available [commands](/guide/standalone#interactive-cli).
Only access tokens with management permission can access this view.
CLI _(command-line interface)_ displays the current Reposilite output and allows to perform available [commands](/guide/standalone#interactive-cli). Only access tokens with management permission can access this view.

![CLI Preview](/images/guides/dashboard-console.png)

You can also filter those messages using filters, but keep in mind it searches only though the currently cached log entries, not the whole history.
You can also filter those messages using filters, but keep in mind that it searches only through the currently cached log entries, not the whole history.

#### Shared configuration
Shared configuration has been already mentioned in:

* [Guide / Setup :: Shared configuration](/guide/settings#shared-configuration)

Currently, configuration is provided in CDN format:
Currently, configuration is provided in [CDN _(Configuration Data Notation)_](https://github.com/dzikoysk/cdn) format:

![Dashboard / Configuration](/images/guides/web-interface-configuration.png)

You can modify it and reload changes, most of the properties support hot-reloading,
You can modify it and reload changes. Most of the properties support hot-reloading,
so you should see changes immediately _(visual updates after reloading the page)_.

0 comments on commit 40394a7

Please sign in to comment.