JavaScriptSolidServer/bin/jss.js at feature/oauth-flow · JavaScriptSolidServer/JavaScriptSolidServer · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

#!/usr/bin/env node

/**

* JavaScript Solid Server CLI

* Usage:

* jss start [options] Start the server

* jss init Initialize configuration

import { Command } from 'commander';

import { createServer } from '../src/server.js';

import { loadConfig, saveConfig, printConfig, defaults } from '../src/config.js';

import { createInvite, listInvites, revokeInvite } from '../src/idp/invites.js';

import { setQuotaLimit, getQuotaInfo, reconcileQuota, formatBytes } from '../src/storage/quota.js';

import { parseSize } from '../src/config.js';

import fs from 'fs-extra';

import path from 'path';

import { fileURLToPath } from 'url';

import readline from 'readline';

const __dirname = path.dirname(fileURLToPath(import.meta.url));

const pkg = JSON.parse(await fs.readFile(path.join(__dirname, '../package.json'), 'utf8'));

const program = new Command();

program

.name('jss')

.description('JavaScript Solid Server - A minimal, fast, JSON-LD native Solid server')

.version(pkg.version);

/**

* Start command

program

.command('start')

.description('Start the Solid server')

.option('-p, --port <number>', 'Port to listen on', parseInt)

.option('-h, --host <address>', 'Host to bind to')

.option('-r, --root <path>', 'Data directory')

.option('-c, --config <file>', 'Config file path')

.option('--ssl-key <path>', 'Path to SSL private key (PEM)')

.option('--ssl-cert <path>', 'Path to SSL certificate (PEM)')

.option('--multiuser', 'Enable multi-user mode')

.option('--no-multiuser', 'Disable multi-user mode')

.option('--conneg', 'Enable content negotiation (Turtle support)')

.option('--no-conneg', 'Disable content negotiation')

.option('--notifications', 'Enable WebSocket notifications')

.option('--no-notifications', 'Disable WebSocket notifications')

.option('--idp', 'Enable built-in Identity Provider')

.option('--no-idp', 'Disable built-in Identity Provider')

.option('--idp-issuer <url>', 'IdP issuer URL (defaults to server URL)')

.option('--subdomains', 'Enable subdomain-based pods (XSS protection)')

.option('--no-subdomains', 'Disable subdomain-based pods')

.option('--base-domain <domain>', 'Base domain for subdomain pods (e.g., "example.com")')

.option('--mashlib', 'Enable Mashlib data browser (local mode, requires mashlib in node_modules)')

.option('--mashlib-cdn', 'Enable Mashlib data browser (CDN mode, no local files needed)')

.option('--mashlib-module <url>', 'Enable ES module data browser from a URL')

.option('--no-mashlib', 'Disable Mashlib data browser')

.option('--mashlib-version <version>', 'Mashlib version for CDN mode (default: 2.0.0)')

.option('--solidos-ui', 'Enable modern Nextcloud-style UI (requires --mashlib)')

.option('--git', 'Enable Git HTTP backend (clone/push support)')

.option('--no-git', 'Disable Git HTTP backend')

.option('--nostr', 'Enable Nostr relay')

.option('--no-nostr', 'Disable Nostr relay')

.option('--nostr-path <path>', 'Nostr relay WebSocket path (default: /relay)')

.option('--nostr-max-events <n>', 'Max events in relay memory (default: 1000)', parseInt)

.option('--activitypub', 'Enable ActivityPub federation')

.option('--no-activitypub', 'Disable ActivityPub federation')

.option('--ap-username <name>', 'ActivityPub username (default: me)')

.option('--ap-display-name <name>', 'ActivityPub display name')

.option('--ap-summary <text>', 'ActivityPub bio/summary')

.option('--ap-nostr-pubkey <hex>', 'Nostr pubkey for identity linking')

.option('--invite-only', 'Require invite code for registration')

.option('--no-invite-only', 'Allow open registration')

.option('--single-user', 'Single-user mode (creates pod on startup, disables registration)')

.option('--single-user-name <name>', 'Username for single-user mode (default: me)')

.option('--webid-tls', 'Enable WebID-TLS client certificate authentication')

.option('--no-webid-tls', 'Disable WebID-TLS authentication')

.option('--public', 'Allow unauthenticated access (skip WAC, open read/write)')

.option('--read-only', 'Disable PUT/DELETE/PATCH methods (read-only mode)')

.option('--live-reload', 'Inject live reload script into HTML (auto-refresh on changes)')

.option('--mongo', 'Enable MongoDB-backed /db/ route')

.option('--no-mongo', 'Disable MongoDB-backed /db/ route')

.option('--mongo-url <url>', 'MongoDB connection URL (default: mongodb://localhost:27017)')

.option('--mongo-database <name>', 'MongoDB database name (default: solid)')

.option('-q, --quiet', 'Suppress log output')

.option('--log-level <level>', 'Log level: error, warn, info, debug (default: info)')

.option('--print-config', 'Print configuration and exit')

.action(async (options) => {

try {

const config = await loadConfig(options, options.config);

// Set DATA_ROOT env var so all modules use the same data directory

process.env.DATA_ROOT = path.resolve(config.root);

if (options.printConfig) {

printConfig(config);

process.exit(0);

}

// Determine IdP issuer URL

const protocol = config.ssl ? 'https' : 'http';

const serverHost = config.host === '0.0.0.0' ? 'localhost' : config.host;

const baseUrl = `${protocol}://${serverHost}:${config.port}`;

// Ensure issuer has trailing slash for CTH compatibility

let idpIssuer = config.idpIssuer || baseUrl;

if (idpIssuer && !idpIssuer.endsWith('/')) {

idpIssuer = idpIssuer + '/';

}

// Create and start server

const server = createServer({

port: config.port,

host: config.host,

logger: config.logger,

conneg: config.conneg,

notifications: config.notifications,

idp: config.idp,

idpIssuer: idpIssuer,

ssl: config.ssl ? {

key: await fs.readFile(config.sslKey),

cert: await fs.readFile(config.sslCert),

} : null,

root: config.root,

subdomains: config.subdomains,

baseDomain: config.baseDomain,

mashlib: config.mashlib || config.mashlibCdn,

mashlibCdn: config.mashlibCdn,

mashlibVersion: config.mashlibVersion,

mashlibModule: config.mashlibModule,

solidosUi: config.solidosUi,

git: config.git,

nostr: config.nostr,

nostrPath: config.nostrPath,

nostrMaxEvents: config.nostrMaxEvents,

activitypub: config.activitypub,

apUsername: config.apUsername,

apDisplayName: config.apDisplayName,

apSummary: config.apSummary,

apNostrPubkey: config.apNostrPubkey,

inviteOnly: config.inviteOnly,

webidTls: config.webidTls,

singleUser: config.singleUser,

singleUserName: config.singleUserName,

public: config.public,

readOnly: config.readOnly,

liveReload: config.liveReload,

mongo: config.mongo,

mongoUrl: config.mongoUrl,

mongoDatabase: config.mongoDatabase,

});

await server.listen({ port: config.port, host: config.host });

if (!config.quiet) {

console.log(`\n JavaScript Solid Server v${pkg.version}`);

console.log(` ${baseUrl}/`);

console.log(`\n Data: ${path.resolve(config.root)}`);

if (config.ssl) console.log(' SSL: enabled');

if (config.conneg) console.log(' Conneg: enabled');

if (config.notifications) console.log(' WebSocket: enabled');

if (config.idp) console.log(` IdP: ${idpIssuer}`);

if (config.subdomains) console.log(` Subdomains: ${config.baseDomain} (XSS protection enabled)`);

if (config.mashlibCdn) {

console.log(` Mashlib: v${config.mashlibVersion} (CDN mode)`);

} else if (config.mashlib) {

console.log(` Mashlib: local (data browser enabled)`);

}

if (config.mashlibModule) console.log(` Mashlib module: ${config.mashlibModule}`);

if (config.solidosUi) console.log(' SolidOS UI: enabled (modern interface)');

if (config.git) console.log(' Git: enabled (clone/push support)');

if (config.nostr) console.log(` Nostr: enabled (${config.nostrPath})`);

if (config.activitypub) console.log(` ActivityPub: enabled (@${config.apUsername || 'me'})`);

if (config.singleUser) console.log(` Single-user: ${config.singleUserName || 'me'} (registration disabled)`);

else if (config.inviteOnly) console.log(' Registration: invite-only');

if (config.webidTls) console.log(' WebID-TLS: enabled (client certificate auth)');

if (config.public) {

console.log('');

console.log(' ⚠️ WARNING: PUBLIC MODE ENABLED');

console.log(' All files are accessible without authentication.');

if (!config.readOnly) {

console.log(' Anyone can read, write, and delete files.');

}

console.log(' Do not expose to the internet!');

}

if (config.mongo) console.log(` MongoDB: ${config.mongoUrl} (${config.mongoDatabase})`);

if (config.readOnly) console.log(' Read-only: enabled (PUT/DELETE/PATCH disabled)');

console.log('\n Press Ctrl+C to stop\n');

}

// Handle shutdown

const shutdown = async () => {

if (!config.quiet) console.log('\n Shutting down...');

await server.close();

process.exit(0);

};

process.on('SIGINT', shutdown);

process.on('SIGTERM', shutdown);

// Gracefully handle ECONNRESET — normal network noise from clients

// closing connections early (browser navigation, health checks, etc.)

process.on('uncaughtException', (err) => {

if (err.code === 'ECONNRESET' || err.code === 'EPIPE' || err.code === 'ECONNABORTED') {

return;

}

console.error('Uncaught exception:', err);

process.exit(1);

});

} catch (err) {

console.error(`Error: ${err.message}`);

process.exit(1);

}

});

/**

* Init command - interactive configuration

program

.command('init')

.description('Initialize server configuration')

.option('-c, --config <file>', 'Config file path', './config.json')

.option('-y, --yes', 'Accept defaults without prompting')

.action(async (options) => {

const configFile = path.resolve(options.config);

// Check if config already exists

if (await fs.pathExists(configFile)) {

console.log(`Config file already exists: ${configFile}`);

const overwrite = options.yes ? true : await confirm('Overwrite?');

if (!overwrite) {

console.log('Aborted.');

process.exit(0);

}

let config;

if (options.yes) {

// Use defaults

config = { ...defaults };

} else {

// Interactive prompts

console.log('\n JavaScript Solid Server Setup\n');

config = {

port: await prompt('Port', defaults.port),

root: await prompt('Data directory', defaults.root),

conneg: await confirm('Enable content negotiation (Turtle support)?', defaults.conneg),

notifications: await confirm('Enable WebSocket notifications?', defaults.notifications),

};

// Ask about SSL

const useSSL = await confirm('Configure SSL?', false);

if (useSSL) {

config.sslKey = await prompt('SSL key path', './ssl/key.pem');

config.sslCert = await prompt('SSL certificate path', './ssl/cert.pem');

}

// Ask about IdP

config.idp = await confirm('Enable built-in Identity Provider?', false);

if (config.idp) {

const customIssuer = await confirm('Use custom issuer URL?', false);

if (customIssuer) {

config.idpIssuer = await prompt('IdP issuer URL', 'https://example.com');

}

console.log('');

}

// Save config

await saveConfig(config, configFile);

console.log(`Configuration saved to: ${configFile}`);

// Create data directory

const dataDir = path.resolve(config.root);

await fs.ensureDir(dataDir);

console.log(`Data directory created: ${dataDir}`);

console.log('\nRun `jss start` to start the server.\n');

});

/**

* Invite command - manage invite codes

const inviteCmd = program

.command('invite')

.description('Manage invite codes for registration');

inviteCmd

.command('create')

.description('Create a new invite code')

.option('-u, --uses <number>', 'Maximum uses (default: 1)', parseInt, 1)

.option('-n, --note <text>', 'Optional note/description')

.option('-r, --root <path>', 'Data directory')

.action(async (options) => {

try {

// Set DATA_ROOT if provided

if (options.root) {

process.env.DATA_ROOT = path.resolve(options.root);

}

const { code, invite } = await createInvite({

maxUses: options.uses,

note: options.note || ''

});

console.log(`\nCreated invite code: ${code}`);

if (invite.maxUses > 1) {

console.log(`Uses: 0/${invite.maxUses}`);

}

if (invite.note) {

console.log(`Note: ${invite.note}`);

}

console.log('');

} catch (err) {

console.error(`Error: ${err.message}`);

process.exit(1);

}

});

inviteCmd

.command('list')

.description('List all invite codes')

.option('-r, --root <path>', 'Data directory')

.action(async (options) => {

try {

// Set DATA_ROOT if provided

if (options.root) {

process.env.DATA_ROOT = path.resolve(options.root);

}

const invites = await listInvites();

if (invites.length === 0) {

console.log('\nNo invite codes found.\n');

return;

}

console.log('\n CODE USES CREATED NOTE');

console.log(' ' + '-'.repeat(55));

for (const invite of invites) {

const uses = `${invite.uses}/${invite.maxUses}`.padEnd(8);

const created = invite.created.split('T')[0];

const note = invite.note || '';

console.log(` ${invite.code} ${uses} ${created} ${note}`);

}

console.log('');

} catch (err) {

console.error(`Error: ${err.message}`);

process.exit(1);

}

});

inviteCmd

.command('revoke <code>')

.description('Revoke an invite code')

.option('-r, --root <path>', 'Data directory')

.action(async (code, options) => {

try {

// Set DATA_ROOT if provided

if (options.root) {

process.env.DATA_ROOT = path.resolve(options.root);

}

const success = await revokeInvite(code);

if (success) {

console.log(`\nRevoked invite code: ${code.toUpperCase()}\n`);

} else {

console.log(`\nInvite code not found: ${code.toUpperCase()}\n`);

process.exit(1);

}

} catch (err) {

console.error(`Error: ${err.message}`);

process.exit(1);

}

});

/**

* Quota command - manage storage quotas

const quotaCmd = program

.command('quota')

.description('Manage storage quotas for pods');

quotaCmd

.command('set <username> <size>')

.description('Set quota limit for a user (e.g., 50MB, 1GB)')

.option('-r, --root <path>', 'Data directory')

.action(async (username, size, options) => {

try {

if (options.root) {

process.env.DATA_ROOT = path.resolve(options.root);

}

const bytes = parseSize(size);

if (bytes === 0) {

console.error('Invalid size format. Use e.g., 50MB, 1GB');

process.exit(1);

}

const quota = await setQuotaLimit(username, bytes);

console.log(`\nQuota set for ${username}: ${formatBytes(quota.limit)}`);

console.log(`Current usage: ${formatBytes(quota.used)} (${Math.round(quota.used / quota.limit * 100)}%)\n`);

} catch (err) {

console.error(`Error: ${err.message}`);

process.exit(1);

}

});

quotaCmd

.command('show <username>')

.description('Show quota info for a user')

.option('-r, --root <path>', 'Data directory')

.action(async (username, options) => {

try {

if (options.root) {

process.env.DATA_ROOT = path.resolve(options.root);

}

const quota = await getQuotaInfo(username);

if (quota.limit === 0) {

console.log(`\n${username}: No quota set (unlimited)\n`);

} else {

console.log(`\n${username}:`);

console.log(` Used: ${formatBytes(quota.used)}`);

console.log(` Limit: ${formatBytes(quota.limit)}`);

console.log(` Free: ${formatBytes(quota.limit - quota.used)}`);

console.log(` Usage: ${quota.percent}%\n`);

}

} catch (err) {

console.error(`Error: ${err.message}`);

process.exit(1);

}

});

quotaCmd

.command('reconcile <username>')

.description('Recalculate quota usage from actual disk usage')

.option('-r, --root <path>', 'Data directory')

.action(async (username, options) => {

try {

if (options.root) {

process.env.DATA_ROOT = path.resolve(options.root);

}

console.log(`Calculating actual disk usage for ${username}...`);

const quota = await reconcileQuota(username);

if (quota.limit === 0) {

console.log(`\n${username}: No quota configured\n`);

} else {

console.log(`\nReconciled ${username}:`);

console.log(` Used: ${formatBytes(quota.used)}`);

console.log(` Limit: ${formatBytes(quota.limit)}`);

console.log(` Usage: ${Math.round(quota.used / quota.limit * 100)}%\n`);

}

} catch (err) {

console.error(`Error: ${err.message}`);

process.exit(1);

}

});

/**

* Helper: Prompt for input

async function prompt(question, defaultValue) {

const rl = readline.createInterface({

input: process.stdin,

output: process.stdout

});

return new Promise((resolve) => {

const defaultStr = defaultValue !== undefined ? ` (${defaultValue})` : '';

rl.question(` ${question}${defaultStr}: `, (answer) => {

rl.close();

const value = answer.trim() || defaultValue;

// Parse numbers

if (typeof defaultValue === 'number' && !isNaN(value)) {

resolve(parseInt(value, 10));

} else {

resolve(value);

}

});

}

/**

* Helper: Confirm yes/no

async function confirm(question, defaultValue = false) {

const rl = readline.createInterface({

input: process.stdin,

output: process.stdout

});

return new Promise((resolve) => {

const hint = defaultValue ? '[Y/n]' : '[y/N]';

rl.question(` ${question} ${hint}: `, (answer) => {

rl.close();

const normalized = answer.trim().toLowerCase();

if (normalized === '') {

resolve(defaultValue);

} else {

resolve(normalized === 'y' || normalized === 'yes');

}

});

}

// Parse and run

program.parse();

JavaScriptSolidServer/bin/jss.js at feature/oauth-flow · JavaScriptSolidServer/JavaScriptSolidServer · GitHub

Repository navigation

Expand file tree

Breadcrumbs

jss.js

Latest commit

History

Breadcrumbs

jss.js

File metadata and controls