Skip to content

Commit

Permalink
Added README.md and dev-start-server.sh script for development. (#192)
Browse files Browse the repository at this point in the history
Co-authored-by: Peter Tandler <[email protected]>
  • Loading branch information
ptandler and Peter Tandler committed Sep 17, 2023
1 parent 417128d commit 0411dea
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Kopia HTML Ui

This is the repository for the html UI for kopia. It is bundled as part of the [kopia UI releases (e.g. `KopiaUI-Setup-X.Y.Z.exe` or a `kopiaui` package)](https://kopia.io/docs/installation/#two-variants-of-kopia).

## Reporting issues

If you want to report a bug or have an idea for a feature request, please use the [issues list of the main kopia repository](https://github.com/kopia/kopia/issues?q=is%3Aissue+is%3Aopen+gui).

## Development

The kopia UI uses [React](https://react.dev/). It connects to a kopia server running locally.

If you want to run a local version of the GUI (e.g. for development), you need to start a kopia server first.
As the UI version might be ahead of the latest release and might depend on changes in the server, it's recommended
that you also clone the [kopia server repository](https://github.com/kopia/kopia#readme) and start the server from there (GO required).

You can use this script like this one. Here it's assumed that you cloned the server repo next to the htmlui.

```bash
#! /bin/bash
(
cd ../kopia
# start kopia server with default repo:
#go run . server start --insecure --without-password --disable-csrf-token-checks --log-level=debug

# for development you might want to use another repository for testing only, not your normal one, so you could use, e.g.
go run . server start --insecure --without-password --disable-csrf-token-checks --log-level=debug --config-file=$HOME/.config/kopia/disabled/repository-dev.config
)
```
9 changes: 9 additions & 0 deletions dev-start-server.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#! /bin/bash
(
cd ../kopia
# start kopia server with default repo:
#go run . server start --insecure --without-password --disable-csrf-token-checks --log-level=debug

# for development you might want to use another repository for testing only, not your normal one, so you could use, e.g.
go run . server start --insecure --without-password --disable-csrf-token-checks --log-level=debug --config-file=$HOME/.config/kopia/disabled/repository-dev.config
)

0 comments on commit 0411dea

Please sign in to comment.