mirror of
https://github.com/khairul169/garage-webui.git
synced 2025-04-28 14:59:31 +07:00
Compare commits
6 Commits
Author | SHA1 | Date | |
---|---|---|---|
b2bc905e3c | |||
59e68455b6 | |||
f30d4289f1 | |||
e6e21d3c01 | |||
2aaaf87dfd | |||
04a10eadfd |
15
README.md
15
README.md
@ -41,7 +41,7 @@ services:
|
|||||||
ports:
|
ports:
|
||||||
- 3900:3900
|
- 3900:3900
|
||||||
- 3901:3901
|
- 3901:3901
|
||||||
- 3902:3903
|
- 3902:3902
|
||||||
- 3903:3903
|
- 3903:3903
|
||||||
|
|
||||||
webui:
|
webui:
|
||||||
@ -62,7 +62,7 @@ services:
|
|||||||
Get the latest binary from the [release page](https://github.com/khairul169/garage-webui/releases/latest) according to your OS architecture. For example:
|
Get the latest binary from the [release page](https://github.com/khairul169/garage-webui/releases/latest) according to your OS architecture. For example:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ wget -O garage-webui https://github.com/khairul169/garage-webui/releases/download/1.0.7/garage-webui-v1.0.7-linux-amd64
|
$ wget -O garage-webui https://github.com/khairul169/garage-webui/releases/download/1.0.9/garage-webui-v1.0.9-linux-amd64
|
||||||
$ chmod +x garage-webui
|
$ chmod +x garage-webui
|
||||||
$ sudo cp garage-webui /usr/local/bin
|
$ sudo cp garage-webui /usr/local/bin
|
||||||
```
|
```
|
||||||
@ -136,9 +136,14 @@ admin_token = "YOUR_ADMIN_TOKEN_HERE"
|
|||||||
metrics_token = "YOUR_METRICS_TOKEN_HERE"
|
metrics_token = "YOUR_METRICS_TOKEN_HERE"
|
||||||
```
|
```
|
||||||
|
|
||||||
However, if it fails to load, you can set these environment variables instead:
|
However, if it fails to load, you can set `API_BASE_URL` & `API_ADMIN_KEY` environment variables instead.
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
|
||||||
|
Configurable envs:
|
||||||
|
|
||||||
- `CONFIG_PATH`: Path to the Garage `config.toml` file. Defaults to `/etc/garage.toml`.
|
- `CONFIG_PATH`: Path to the Garage `config.toml` file. Defaults to `/etc/garage.toml`.
|
||||||
|
- `BASE_PATH`: Base path or prefix for Web UI.
|
||||||
- `API_BASE_URL`: Garage admin API endpoint URL.
|
- `API_BASE_URL`: Garage admin API endpoint URL.
|
||||||
- `API_ADMIN_KEY`: Admin API key.
|
- `API_ADMIN_KEY`: Admin API key.
|
||||||
- `S3_REGION`: S3 Region.
|
- `S3_REGION`: S3 Region.
|
||||||
@ -146,7 +151,9 @@ However, if it fails to load, you can set these environment variables instead:
|
|||||||
|
|
||||||
### Authentication
|
### Authentication
|
||||||
|
|
||||||
Enable authentication by setting `AUTH_USER_PASS` environment variable. Generate the username and password hash using the following command:
|
Enable authentication by setting the `AUTH_USER_PASS` environment variable in the format `username:password_hash`, where `password_hash` is a bcrypt hash of the password.
|
||||||
|
|
||||||
|
Generate the username and password hash using the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
htpasswd -nbBC 10 "YOUR_USERNAME" "YOUR_PASSWORD"
|
htpasswd -nbBC 10 "YOUR_USERNAME" "YOUR_PASSWORD"
|
||||||
|
6
backend/.env.example
Normal file
6
backend/.env.example
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
#
|
||||||
|
BASE_PATH=""
|
||||||
|
AUTH_USER_PASS='username:$2y$10$DSTi9o0uQPEHSNlf66xMEOgm9KgVNBP3vHxA3SK0Xha2EVMb3mTXm'
|
||||||
|
API_BASE_URL="http://garage:3903"
|
||||||
|
S3_ENDPOINT_URL="http://garage:3900"
|
||||||
|
API_ADMIN_KEY=""
|
@ -7,6 +7,7 @@ import (
|
|||||||
"khairul169/garage-webui/utils"
|
"khairul169/garage-webui/utils"
|
||||||
"log"
|
"log"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"os"
|
||||||
|
|
||||||
"github.com/joho/godotenv"
|
"github.com/joho/godotenv"
|
||||||
)
|
)
|
||||||
@ -21,10 +22,21 @@ func main() {
|
|||||||
log.Println("Cannot load garage config!", err)
|
log.Println("Cannot load garage config!", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
basePath := os.Getenv("BASE_PATH")
|
||||||
mux := http.NewServeMux()
|
mux := http.NewServeMux()
|
||||||
mux.Handle("/api/", http.StripPrefix("/api", router.HandleApiRouter()))
|
|
||||||
|
// Serve API
|
||||||
|
apiPrefix := basePath + "/api"
|
||||||
|
mux.Handle(apiPrefix+"/", http.StripPrefix(apiPrefix, router.HandleApiRouter()))
|
||||||
|
|
||||||
|
// Static files
|
||||||
ui.ServeUI(mux)
|
ui.ServeUI(mux)
|
||||||
|
|
||||||
|
// Redirect to UI if BASE_PATH is set
|
||||||
|
if basePath != "" {
|
||||||
|
mux.Handle("/", http.RedirectHandler(basePath, http.StatusMovedPermanently))
|
||||||
|
}
|
||||||
|
|
||||||
host := utils.GetEnv("HOST", "0.0.0.0")
|
host := utils.GetEnv("HOST", "0.0.0.0")
|
||||||
port := utils.GetEnv("PORT", "3909")
|
port := utils.GetEnv("PORT", "3909")
|
||||||
|
|
||||||
|
@ -146,11 +146,20 @@ func (b *Browse) GetOneObject(w http.ResponseWriter, r *http.Request) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
w.Header().Set("Content-Type", *object.ContentType)
|
|
||||||
w.Header().Set("Content-Length", strconv.FormatInt(*object.ContentLength, 10))
|
|
||||||
w.Header().Set("Cache-Control", "max-age=86400")
|
w.Header().Set("Cache-Control", "max-age=86400")
|
||||||
w.Header().Set("Last-Modified", object.LastModified.Format(time.RFC1123))
|
w.Header().Set("Last-Modified", object.LastModified.Format(time.RFC1123))
|
||||||
|
|
||||||
|
if object.ContentType != nil {
|
||||||
|
w.Header().Set("Content-Type", *object.ContentType)
|
||||||
|
} else {
|
||||||
|
w.Header().Set("Content-Type", "application/octet-stream")
|
||||||
|
}
|
||||||
|
if object.ContentLength != nil {
|
||||||
|
w.Header().Set("Content-Length", strconv.FormatInt(*object.ContentLength, 10))
|
||||||
|
}
|
||||||
|
if object.ETag != nil {
|
||||||
w.Header().Set("Etag", *object.ETag)
|
w.Header().Set("Etag", *object.ETag)
|
||||||
|
}
|
||||||
|
|
||||||
_, err = io.Copy(w, object.Body)
|
_, err = io.Copy(w, object.Body)
|
||||||
|
|
||||||
|
@ -7,7 +7,10 @@ import (
|
|||||||
"embed"
|
"embed"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"os"
|
||||||
"path"
|
"path"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
//go:embed dist
|
//go:embed dist
|
||||||
@ -16,19 +19,45 @@ var embeddedFs embed.FS
|
|||||||
func ServeUI(mux *http.ServeMux) {
|
func ServeUI(mux *http.ServeMux) {
|
||||||
distFs, _ := fs.Sub(embeddedFs, "dist")
|
distFs, _ := fs.Sub(embeddedFs, "dist")
|
||||||
fileServer := http.FileServer(http.FS(distFs))
|
fileServer := http.FileServer(http.FS(distFs))
|
||||||
|
basePath := os.Getenv("BASE_PATH")
|
||||||
|
|
||||||
mux.Handle("/", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
mux.Handle(basePath+"/", http.StripPrefix(basePath, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
_path := path.Clean(r.URL.Path)[1:]
|
_path := path.Clean(r.URL.Path)[1:]
|
||||||
|
|
||||||
// Rewrite non-existing paths to index.html
|
// Rewrite non-existing paths to index.html
|
||||||
if _, err := fs.Stat(distFs, _path); err != nil {
|
if _, err := fs.Stat(distFs, _path); err != nil {
|
||||||
index, _ := fs.ReadFile(distFs, "index.html")
|
index, _ := fs.ReadFile(distFs, "index.html")
|
||||||
|
html := string(index)
|
||||||
|
|
||||||
|
// Set base path for the UI
|
||||||
|
html = strings.ReplaceAll(html, "%BASE_PATH%", basePath)
|
||||||
|
html = addBasePath(html, basePath)
|
||||||
|
|
||||||
w.Header().Add("Content-Type", "text/html")
|
w.Header().Add("Content-Type", "text/html")
|
||||||
w.WriteHeader(http.StatusOK)
|
w.WriteHeader(http.StatusOK)
|
||||||
w.Write(index)
|
w.Write([]byte(html))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add prefix to each /assets strings in js
|
||||||
|
if len(basePath) > 0 && strings.HasSuffix(_path, ".js") {
|
||||||
|
data, _ := fs.ReadFile(distFs, _path)
|
||||||
|
html := string(data)
|
||||||
|
html = strings.ReplaceAll(html, "assets/", basePath[1:]+"/assets/")
|
||||||
|
|
||||||
|
w.Header().Add("Content-Type", "text/javascript")
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
w.Write([]byte(html))
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
fileServer.ServeHTTP(w, r)
|
fileServer.ServeHTTP(w, r)
|
||||||
}))
|
})))
|
||||||
|
}
|
||||||
|
|
||||||
|
func addBasePath(html string, basePath string) string {
|
||||||
|
re := regexp.MustCompile(`(href|src)=["'](/[^"'>]+)["']`)
|
||||||
|
return re.ReplaceAllStringFunc(html, func(match string) string {
|
||||||
|
return re.ReplaceAllString(match, `$1="`+basePath+`$2"`)
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
@ -10,6 +10,9 @@
|
|||||||
<link rel="manifest" href="/site.webmanifest" />
|
<link rel="manifest" href="/site.webmanifest" />
|
||||||
|
|
||||||
<title>Garage Web UI</title>
|
<title>Garage Web UI</title>
|
||||||
|
<script>
|
||||||
|
window.__BASE_PATH = "%BASE_PATH%";
|
||||||
|
</script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div id="root"></div>
|
<div id="root"></div>
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "garage-webui",
|
"name": "garage-webui",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "1.0.7",
|
"version": "1.0.9",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev:client": "vite",
|
"dev:client": "vite",
|
||||||
|
@ -2,6 +2,7 @@ import { createBrowserRouter, RouterProvider } from "react-router-dom";
|
|||||||
import { lazy, Suspense } from "react";
|
import { lazy, Suspense } from "react";
|
||||||
import AuthLayout from "@/components/layouts/auth-layout";
|
import AuthLayout from "@/components/layouts/auth-layout";
|
||||||
import MainLayout from "@/components/layouts/main-layout";
|
import MainLayout from "@/components/layouts/main-layout";
|
||||||
|
import { BASE_PATH } from "@/lib/consts";
|
||||||
|
|
||||||
const LoginPage = lazy(() => import("@/pages/auth/login"));
|
const LoginPage = lazy(() => import("@/pages/auth/login"));
|
||||||
const ClusterPage = lazy(() => import("@/pages/cluster/page"));
|
const ClusterPage = lazy(() => import("@/pages/cluster/page"));
|
||||||
@ -10,7 +11,8 @@ const BucketsPage = lazy(() => import("@/pages/buckets/page"));
|
|||||||
const ManageBucketPage = lazy(() => import("@/pages/buckets/manage/page"));
|
const ManageBucketPage = lazy(() => import("@/pages/buckets/manage/page"));
|
||||||
const KeysPage = lazy(() => import("@/pages/keys/page"));
|
const KeysPage = lazy(() => import("@/pages/keys/page"));
|
||||||
|
|
||||||
const router = createBrowserRouter([
|
const router = createBrowserRouter(
|
||||||
|
[
|
||||||
{
|
{
|
||||||
path: "/auth",
|
path: "/auth",
|
||||||
Component: AuthLayout,
|
Component: AuthLayout,
|
||||||
@ -46,7 +48,11 @@ const router = createBrowserRouter([
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
]);
|
],
|
||||||
|
{
|
||||||
|
basename: BASE_PATH,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
const Router = () => {
|
const Router = () => {
|
||||||
return (
|
return (
|
||||||
|
@ -13,8 +13,9 @@ import Button from "../ui/button";
|
|||||||
import { themes } from "@/app/themes";
|
import { themes } from "@/app/themes";
|
||||||
import appStore from "@/stores/app-store";
|
import appStore from "@/stores/app-store";
|
||||||
import garageLogo from "@/assets/garage-logo.svg";
|
import garageLogo from "@/assets/garage-logo.svg";
|
||||||
import { useMutation, useQueryClient } from "@tanstack/react-query";
|
import { useMutation } from "@tanstack/react-query";
|
||||||
import api from "@/lib/api";
|
import api from "@/lib/api";
|
||||||
|
import * as utils from "@/lib/utils";
|
||||||
import { toast } from "sonner";
|
import { toast } from "sonner";
|
||||||
import { useAuth } from "@/hooks/useAuth";
|
import { useAuth } from "@/hooks/useAuth";
|
||||||
|
|
||||||
@ -90,12 +91,10 @@ const Sidebar = () => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const LogoutButton = () => {
|
const LogoutButton = () => {
|
||||||
const queryClient = useQueryClient();
|
|
||||||
|
|
||||||
const logout = useMutation({
|
const logout = useMutation({
|
||||||
mutationFn: () => api.post("/auth/logout"),
|
mutationFn: () => api.post("/auth/logout"),
|
||||||
onSuccess: () => {
|
onSuccess: () => {
|
||||||
queryClient.invalidateQueries({ queryKey: ["auth"] });
|
window.location.href = utils.url("/auth/login");
|
||||||
},
|
},
|
||||||
onError: (err) => {
|
onError: (err) => {
|
||||||
toast.error(err?.message || "Unknown error");
|
toast.error(err?.message || "Unknown error");
|
||||||
|
7
src/global.d.ts
vendored
Normal file
7
src/global.d.ts
vendored
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
export {};
|
||||||
|
|
||||||
|
declare global {
|
||||||
|
interface Window {
|
||||||
|
__BASE_PATH?: string;
|
||||||
|
}
|
||||||
|
}
|
@ -1,10 +1,23 @@
|
|||||||
|
import * as utils from "@/lib/utils";
|
||||||
|
import { BASE_PATH } from "./consts";
|
||||||
|
|
||||||
type FetchOptions = Omit<RequestInit, "headers" | "body"> & {
|
type FetchOptions = Omit<RequestInit, "headers" | "body"> & {
|
||||||
params?: Record<string, any>;
|
params?: Record<string, any>;
|
||||||
headers?: Record<string, string>;
|
headers?: Record<string, string>;
|
||||||
body?: any;
|
body?: any;
|
||||||
};
|
};
|
||||||
|
|
||||||
export const API_URL = "/api";
|
export const API_URL = BASE_PATH + "/api";
|
||||||
|
|
||||||
|
export class APIError extends Error {
|
||||||
|
status!: number;
|
||||||
|
|
||||||
|
constructor(message: string, status: number = 400) {
|
||||||
|
super(message);
|
||||||
|
this.name = "APIError";
|
||||||
|
this.status = status;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const api = {
|
const api = {
|
||||||
async fetch<T = any>(url: string, options?: Partial<FetchOptions>) {
|
async fetch<T = any>(url: string, options?: Partial<FetchOptions>) {
|
||||||
@ -36,13 +49,18 @@ const api = {
|
|||||||
?.includes("application/json");
|
?.includes("application/json");
|
||||||
const data = isJson ? await res.json() : await res.text();
|
const data = isJson ? await res.json() : await res.text();
|
||||||
|
|
||||||
|
if (res.status === 401 && !url.startsWith("/auth")) {
|
||||||
|
window.location.href = utils.url("/auth/login");
|
||||||
|
throw new APIError("unauthorized", res.status);
|
||||||
|
}
|
||||||
|
|
||||||
if (!res.ok) {
|
if (!res.ok) {
|
||||||
const message = isJson
|
const message = isJson
|
||||||
? data?.message
|
? data?.message
|
||||||
: typeof data === "string"
|
: typeof data === "string"
|
||||||
? data
|
? data
|
||||||
: res.statusText;
|
: res.statusText;
|
||||||
throw new Error(message);
|
throw new APIError(message, res.status);
|
||||||
}
|
}
|
||||||
|
|
||||||
return data as unknown as T;
|
return data as unknown as T;
|
||||||
|
6
src/lib/consts.ts
Normal file
6
src/lib/consts.ts
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
// consts.ts
|
||||||
|
|
||||||
|
export const BASE_PATH =
|
||||||
|
(import.meta.env.PROD ? window.__BASE_PATH : null) ||
|
||||||
|
import.meta.env.VITE_BASE_PATH ||
|
||||||
|
"";
|
@ -3,6 +3,7 @@ import { toast } from "sonner";
|
|||||||
import { twMerge } from "tailwind-merge";
|
import { twMerge } from "tailwind-merge";
|
||||||
import dayjsRelativeTime from "dayjs/plugin/relativeTime";
|
import dayjsRelativeTime from "dayjs/plugin/relativeTime";
|
||||||
import dayjs from "dayjs";
|
import dayjs from "dayjs";
|
||||||
|
import { BASE_PATH } from "./consts";
|
||||||
|
|
||||||
dayjs.extend(dayjsRelativeTime);
|
dayjs.extend(dayjsRelativeTime);
|
||||||
export { dayjs };
|
export { dayjs };
|
||||||
@ -53,3 +54,7 @@ export const copyToClipboard = async (text: string) => {
|
|||||||
textArea?.remove();
|
textArea?.remove();
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const url = (...paths: unknown[]) => {
|
||||||
|
return BASE_PATH + paths.join("/");
|
||||||
|
};
|
||||||
|
Loading…
x
Reference in New Issue
Block a user