Compare commits

...

4 commits

Author SHA1 Message Date
ZTatman
9e3e30a37a Merge origin/main into fix/borderless-btn-red-default 2026-09-04 11:55:30 -04:00
ZTatman
0ba72942b6 fix(cli): address PR review feedback 2026-09-04 11:54:42 -04:00
acf44ab67e
Merge pull request #25 from ZTatman/chore/rename-to-firebreak
chore: clean up project structure and remove dead code
2026-08-16 20:05:34 -04:00
ZTatman
6e8fa0ab06 fix: address PR review feedback 2026-08-16 20:04:26 -04:00
7 changed files with 76 additions and 40 deletions

View file

@ -115,3 +115,15 @@ This file is the single source of truth for codebase obstacles, oddities, and th
**Obstacle:** Theme switching and persisted localStorage theme state conflicted with the current Firebreak brand pass, especially on the cinematic landing page.
**Solution/Workaround:** Force the root document to use the `.dark` token set and remove the theme toggle UI/scripts.
**Preference:** Keep semantic dark tokens; only reintroduce theme switching after the dark Firebreak identity is stable.
### Forgejo repository check accepted empty accounts
**Area:** cli/src/utils/forgejo-checks.ts
**Obstacle:** `checkRepoAccess` treated any parsed user object as success, even when Forgejo reported zero accessible repositories.
**Solution/Workaround:** Require `totalRepos > 0` before returning the existing success result; preserve the existing zero-repository failure.
**Preference:** A valid token alone is insufficient for repository-access verification.
### Forgejo PAT could be sent over remote HTTP
**Area:** cli/src/utils/forgejo-checks.ts, cli/src/commands/config/init.ts
**Obstacle:** CLI setup and verification accepted remote `http://` Forgejo URLs, allowing the PAT to be sent without transport encryption.
**Solution/Workaround:** Centralize Forgejo URL validation, require HTTPS for non-local endpoints, and allow HTTP only for the documented `forgejo` service and loopback hosts. Validate again inside authenticated checks before constructing requests.
**Preference:** Reject insecure remote transport instead of adding an acknowledgement flag.

View file

@ -5,36 +5,9 @@ import * as c from "yoctocolors";
import * as p from "@clack/prompts";
import { generateEnvFile, SECRET_ENV_KEYS } from "../../utils/config.js";
import { validateForgejoBaseUrl } from "../../utils/forgejo-checks.js";
import { CommandConfig } from "../../cli-router.js";
function validateHttpUrlOrHost(
value: string | undefined,
label: string,
): string | undefined {
const trimmed = value?.trim();
if (!trimmed) return `${label} is required`;
const hasProtocol = /^[a-z]+:\/\//i.test(trimmed);
const isHttp = /^https?:\/\//i.test(trimmed);
if (hasProtocol && !isHttp) {
return `${label} must use http:// or https://`;
}
if (!hasProtocol) {
return `${label} must include a scheme — e.g. http://forgejo:3000 or https://git.example.com`;
}
try {
const url = new URL(trimmed);
if (!url.hostname) return `${label} must include a domain or hostname`;
} catch {
return `${label} must be a valid URL`;
}
return undefined;
}
async function init(opts: { output?: string }) {
p.intro(c.bold("firebreak config init"));
p.note(
@ -118,7 +91,7 @@ async function init(opts: { output?: string }) {
message:
"Forgejo API URL (how Firebreak reaches Forgejo, not your browser URL)?",
placeholder: "http://forgejo:3000",
validate: (v) => validateHttpUrlOrHost(v, "Forgejo base URL"),
validate: (v) => validateForgejoBaseUrl(v),
}),
forgejoPat: () =>
p.password({
@ -178,7 +151,7 @@ async function init(opts: { output?: string }) {
].join("\n"),
);
p.log.success(
"Done. Verify firebreak's connection using the 'verify' command.\nOnce verified, deploy!",
"Done. Verify Firebreak's connection using 'firebreak config verify'.\nOnce verified, deploy!",
);
} catch (error) {
s.stop();

View file

@ -162,7 +162,7 @@ async function runForgejoChecks(
async function verifyCommand(opts: VerifyOptions): Promise<void> {
const isDiagnostic = opts.diagnostic ?? false;
p.intro(c.bold("firebreak verify"));
p.intro(c.bold("firebreak config verify"));
const config = loadConfig();
if (!config) {

View file

@ -1,5 +1,13 @@
const TIMEOUT = 5000;
const LOCAL_HTTP_HOSTS = new Set([
"forgejo",
"localhost",
"127.0.0.1",
"::1",
"[::1]",
]);
export type CheckResult = {
name: string;
success: boolean;
@ -18,6 +26,42 @@ export function createCheckResult(
return result;
}
export function validateForgejoBaseUrl(
value: string | undefined,
label = "Forgejo base URL",
): string | undefined {
const trimmed = value?.trim();
if (!trimmed) return `${label} is required`;
const hasProtocol = /^[a-z]+:\/\//i.test(trimmed);
const isHttp = /^https?:\/\//i.test(trimmed);
if (hasProtocol && !isHttp) {
return `${label} must use http:// or https://`;
}
if (!hasProtocol) {
return `${label} must include a scheme — e.g. http://forgejo:3000 or https://git.example.com`;
}
try {
const url = new URL(trimmed);
if (!url.hostname) return `${label} must include a domain or hostname`;
const isLocalHttp =
url.protocol === "http:" &&
(LOCAL_HTTP_HOSTS.has(url.hostname) ||
url.hostname.endsWith(".localhost"));
if (url.protocol === "http:" && !isLocalHttp) {
return `${label} must use https:// unless it is a local Forgejo endpoint`;
}
} catch {
return `${label} must be a valid URL`;
}
return undefined;
}
async function fetchWithTimeout(
url: string,
init: RequestInit,
@ -47,6 +91,11 @@ function getErrorMessage(error: unknown, context: string): string {
export async function checkForgejoReachability(
baseUrl: string,
): Promise<CheckResult> {
const validationError = validateForgejoBaseUrl(baseUrl);
if (validationError) {
return createCheckResult("Forgejo", false, validationError);
}
try {
const response = await fetchWithTimeout(baseUrl, { method: "GET" });
if (response.ok) {
@ -70,6 +119,11 @@ export async function checkRepoAccess(
baseUrl: string,
pat: string,
): Promise<CheckResult> {
const validationError = validateForgejoBaseUrl(baseUrl);
if (validationError) {
return createCheckResult("Forgejo", false, validationError);
}
try {
const responses = await Promise.all([
fetchWithTimeout(`${baseUrl}/api/v1/user`, {
@ -101,7 +155,7 @@ export async function checkRepoAccess(
reposResponse.headers.get("x-total-count") ?? "0",
);
if (user) {
if (user && totalRepos > 0) {
return createCheckResult(
"Forgejo",
true,

View file

@ -173,7 +173,7 @@ For Dokploy users, deploying Firebreak is similar to deploying any other contain
Firebreak uses its own Postgres database on the same DB server as Forgejo:
- Separate databases (e.g., `forgejo` and `firebreak`)
- Separate databases (e.g., `forgejo` and `firebreak_db`)
- NOT shared tables or schemas
- Operators can run both on a small VPS efficiently
- Independent backups and migrations
@ -204,7 +204,7 @@ The CLI is the primary way to configure and validate Firebreak against an existi
- prompt for the Forgejo base URL, for example `https://git.example.com`
- collect the dedicated Forgejo username Firebreak should use for API access, for example `firebreak-bot`
- collect a user-created Forgejo PAT for that dedicated Forgejo user
- collect Firebreak Postgres connection details, for example `postgresql://firebreak:password@db.example.com:5432/firebreak`
- collect Firebreak Postgres connection details, for example `postgresql://firebreak:password@db.example.com:5432/firebreak_db`
- generate a grant token secret by default unless the operator pastes one
- generate all Firebreak-owned config files needed for deployment in Phase 1
- write `.env`
@ -219,7 +219,7 @@ Suggested `init` prompt guidance:
- Public viewer URL: "What public URL should viewers use for shared links?" Example: `https://share.example.com`
- Private admin URL: "What private URL should operators use for the Firebreak admin UI?" Example: `https://admin.example.com`
- Forgejo base URL: "What is the base URL of your existing Forgejo instance?" Example: `https://git.example.com`
- Firebreak database URL: "What Postgres connection string should Firebreak use?" Example: `postgresql://firebreak:password@db.example.com:5432/firebreak`
- Firebreak database URL: "What Postgres connection string should Firebreak use?" Example: `postgresql://firebreak:password@db.example.com:5432/firebreak_db`
- Dedicated Forgejo username: "What Forgejo username should Firebreak use for API access?" Example: `firebreak-bot`
- Forgejo PAT: "Paste the Forgejo personal access token for that dedicated Forgejo user" Example: `fgp_...`
- Grant token secret: "Paste a grant token secret, or press enter to generate one automatically"

View file

@ -114,7 +114,7 @@ Only repo owners can create view links for their repos.
- public viewer URL, for example `https://share.example.com`
- private admin URL, for example `https://admin.example.com` or `https://firebreak-admin.tailnet.ts.net`
- Forgejo base URL, for example `https://git.example.com`
- Firebreak Postgres URL, for example `postgresql://firebreak:password@db.example.com:5432/firebreak`
- Firebreak Postgres URL, for example `postgresql://firebreak:password@db.example.com:5432/firebreak_db`
- Forgejo bot username, for example `firebreak-bot`
- Forgejo PAT for that dedicated Forgejo user
- grant token secret, with secure auto-generation as the default
@ -164,7 +164,7 @@ For Dokploy users, deploying Firebreak is similar to deploying any other contain
Firebreak uses its own Postgres database on the same DB server as Forgejo:
- separate databases (not shared tables with Forgejo)
- recommended: same PostgreSQL instance with `forgejo` and `firebreak` databases
- recommended: same PostgreSQL instance with `forgejo` and `firebreak_db` databases
- clean schema separation prevents coupling to Forgejo's database schema
- independent backups and migrations
- operators can run both databases on a small VPS efficiently

View file

@ -1,3 +0,0 @@
{
"forgejoBaseUrl": "http://forgejo:3000"
}