https://github.com/no-src/gofs-webui
A web UI tool of the gofs
https://github.com/no-src/gofs-webui
file-synchronization go synchronization
Last synced: 5 months ago
JSON representation
A web UI tool of the gofs
- Host: GitHub
- URL: https://github.com/no-src/gofs-webui
- Owner: no-src
- License: apache-2.0
- Created: 2023-06-23T16:05:15.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-05T03:49:00.000Z (over 1 year ago)
- Last Synced: 2025-02-05T04:25:34.604Z (over 1 year ago)
- Topics: file-synchronization, go, synchronization
- Language: Vue
- Homepage:
- Size: 1020 KB
- Stars: 14
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# gofs-webui
[](https://github.com/no-src/gofs-webui/actions)
[](https://github.com/no-src/gofs-webui/blob/main/LICENSE)
[](https://github.com/no-src/gofs-webui/releases)
A web UI tool of the [gofs](https://github.com/no-src/gofs).
## Installation
The first need [Go](https://go.dev/doc/install) and [Node](https://nodejs.org/en/download) installed, then you can use
the below command to install `gofs-webui`.
### Windows
```bash
$ scripts\build.bat
```
### Linux or macOS
```bash
$ chmod +x ./scripts/build.sh && ./scripts/build.sh
```
### Docker
You can use the [build-docker.sh](/scripts/build-docker.sh) script to build the docker image and you should clone this
repository and `cd` to the root path of the repository first.
```bash
$ chmod +x ./scripts/build-docker.sh && ./scripts/build-docker.sh
```
Or pull the docker image directly from [DockerHub](https://hub.docker.com/r/nosrc/gofs-webui) with the command below.
```bash
$ docker pull nosrc/gofs-webui
```
For more scripts about release and docker, please see the [scripts](/scripts) directory.
## Quick Start
### Windows
```bash
$ gofs-webui.exe
```
### Linux or macOS
```bash
$ ./gofs-webui
```
### Docker
```bash
$ docker run -it --rm --name running-gofs-webui -p 9097:9097 nosrc/gofs-webui:latest gofs-webui
```
## Run gofs
When you generate the configuration file `gofs.json` using `gofs-webui` and have
installed [gofs](https://github.com/no-src/gofs#installation), you can use the following command to run `gofs` and
synchronize your files.
```bash
$ gofs -conf=./gofs.json
```