Allow the user to specify hostname to listen on (#138)

pull/159/head
Jouni K. Seppänen 2022-12-04 07:24:06 +02:00 committed by GitHub
parent 8c62ca981e
commit 9baac2181a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 15 additions and 7 deletions

View File

@ -80,8 +80,9 @@ terminal:
silverbullet <pages-path> silverbullet <pages-path>
``` ```
By default, SB will bind to port `3000`, to use a different port use the By default, SB will bind to port `3000` on all interfaces. To specify a
`--port` flag. By default SB doesnt offer any sort of authentication, to add different address or port to listen on, use the `--hostname` and `--port`
options. By default SB doesnt offer any sort of authentication, to add
basic password authentication, pass the `--password` flag. basic password authentication, pass the `--password` flag.
Once downloaded and booted, SB will print out a URL to open SB in your browser Once downloaded and booted, SB will print out a URL to open SB in your browser

View File

@ -5,11 +5,12 @@ import { AssetBundle, AssetJson } from "../plugos/asset_bundle/bundle.ts";
export function serveCommand(options: any, folder: string) { export function serveCommand(options: any, folder: string) {
const pagesPath = path.resolve(Deno.cwd(), folder); const pagesPath = path.resolve(Deno.cwd(), folder);
const hostname = options.hostname || "0.0.0.0";
const port = options.port || 3000; const port = options.port || 3000;
console.log( console.log(
"Going to start Silver Bullet on port", "Going to start Silver Bullet on",
port, `${hostname}:${port}`,
"serving pages from", "serving pages from",
pagesPath, pagesPath,
"with db file", "with db file",
@ -17,6 +18,7 @@ export function serveCommand(options: any, folder: string) {
); );
const httpServer = new HttpServer({ const httpServer = new HttpServer({
hostname,
port: port, port: port,
pagesPath: pagesPath, pagesPath: pagesPath,
dbPath: path.join(pagesPath, options.db), dbPath: path.join(pagesPath, options.db),

View File

@ -7,6 +7,7 @@ import { SpaceSystem } from "./space_system.ts";
import { parseYamlSettings } from "../common/util.ts"; import { parseYamlSettings } from "../common/util.ts";
export type ServerOptions = { export type ServerOptions = {
hostname: string;
port: number; port: number;
pagesPath: string; pagesPath: string;
dbPath: string; dbPath: string;
@ -19,12 +20,14 @@ const staticLastModified = new Date().toUTCString();
export class HttpServer { export class HttpServer {
app: Application; app: Application;
systemBoot: SpaceSystem; systemBoot: SpaceSystem;
private hostname: string;
private port: number; private port: number;
password?: string; password?: string;
settings: { [key: string]: any } = {}; settings: { [key: string]: any } = {};
abortController?: AbortController; abortController?: AbortController;
constructor(options: ServerOptions) { constructor(options: ServerOptions) {
this.hostname = options.hostname;
this.port = options.port; this.port = options.port;
this.app = new Application(); //{ serverConstructor: FlashServer }); this.app = new Application(); //{ serverConstructor: FlashServer });
this.password = options.password; this.password = options.password;
@ -125,13 +128,14 @@ export class HttpServer {
}); });
this.abortController = new AbortController(); this.abortController = new AbortController();
this.app.listen({ port: this.port, signal: this.abortController.signal }) this.app.listen({ hostname: this.hostname, port: this.port, signal: this.abortController.signal })
.catch((e: any) => { .catch((e: any) => {
console.log("Server listen error:", e.message); console.log("Server listen error:", e.message);
Deno.exit(1); Deno.exit(1);
}); });
const visibleHostname = this.hostname === "0.0.0.0" ? "localhost" : this.hostname;
console.log( console.log(
`Silver Bullet is now running: http://localhost:${this.port}`, `Silver Bullet is now running: http://${visibleHostname}:${this.port}`,
); );
} }

View File

@ -19,6 +19,7 @@ await new Command()
.usage("<options> <folder> | <command> (see below)") .usage("<options> <folder> | <command> (see below)")
// Main command // Main command
.arguments("<folder:string>") .arguments("<folder:string>")
.option("--hostname <hostname:string>", "Hostname or address to listen on")
.option("-p, --port <port:number>", "Port to listen on") .option("-p, --port <port:number>", "Port to listen on")
.option("--db <dbfile:string>", "Filename for the database", { .option("--db <dbfile:string>", "Filename for the database", {
default: "data.db", default: "data.db",

View File

@ -103,7 +103,7 @@ To run Silver Bullet, create a folder for your pages (it can be empty, or be an
silverbullet <pages-path> silverbullet <pages-path>
``` ```
By default, Silver Bullet will bind to port `3000`, to use a different port use the the `--port` flag. By default Silver Bullet is unauthenticated, to password-protect it, specify a password with the `--password` flag. By default, Silver Bullet will bind to port `3000` on all interfaces. To specify a different address or port to listen on, use the the `--hostname` and `--port` flags. By default Silver Bullet is unauthenticated, to password-protect it, specify a password with the `--password` flag.
Once downloaded and booted, Silver Bullet will print out a URL to open SB in your browser (by default this will be http://localhost:3000 ). Once downloaded and booted, Silver Bullet will print out a URL to open SB in your browser (by default this will be http://localhost:3000 ).