pushbits.github.io/docs/index.html at html · pushbits/pushbits.github.io

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

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

<!doctype html>

<head>

<title>PushBits</title>

</head>

</a>

</div>

</div>

</a>

</label>

PushBits

</span>

</div>

Getting Started

</span>

</div>

</label>

</label>

</form>

</label>

</label>

</button>

</nav>

</form>

Initializing search

</div>

</div>

</div>

pushbits/server

</div>

</a>

</div>

</nav>

</header>

</a>

PushBits

</label>

</div>

pushbits/server

</div>

</a>

</div>

Getting Started

</span>

</label>

Getting Started

</span>

</a>

Table of contents

</label>

Installation

</span>

</a>

</li>

Configuration

</span>

</a>

</li>

Usage

</span>

</a>

Message options

</span>

</a>

</li>

Deleting a Message

</span>

</a>

</li>

</ul>

</nav>

</li>

</ul>

</nav>

</li>

User Guide

</span>

</a>

</li>

Developer Guide

</span>

</a>

</li>

</ul>

</nav>

</div>

<h1 id="getting-started">Getting Started</h1>

<h2 id="installation">Installation</h2>

<p>PushBits is meant to be self-hosted.

That means you have to install it on your own server.

You are advised to install PushBits behind a reverse proxy and enable TLS.</p>

<p>Currently, the only supported way of installing PushBits is via <a href="https://www.docker.com/">Docker</a> or <a href="https://podman.io/">Podman</a>.

The image is hosted <a href="https://github.com/pushbits/server/pkgs/container/server">via ghcr.io</a>.</p>

<h2 id="configuration">Configuration</h2>

<p>To see what can be configured, have a look at the <a href="https://github.com/pushbits/server/blob/master/config.example.yml">config.sample.yml</a> file inside the root of the repository.</p>

<p>Settings can optionally be provided via environment variables.

The name of the environment variable is composed of a starting <code>PUSHBITS_</code>, followed by the keys of the setting, all

joined with <code>_</code>.

As an example, the HTTP port can be provided as an environment variable called <code>PUSHBITS_HTTP_PORT</code>.</p>

<p>To get started, here is a Docker Compose file you can use.</p>

<pre><code class="language-yaml">version: '2'

services:

server:

image: ghcr.io/pushbits/server:latest

ports:

- 8080:8080

environment:

PUSHBITS_DATABASE_DIALECT: 'sqlite3'

PUSHBITS_ADMIN_MATRIXID: '@your/matrix/username:matrix.org' # The Matrix account on which the admin will receive their notifications.

PUSHBITS_ADMIN_PASSWORD: 'your/pushbits/password' # The login password of the admin account. Default username is 'admin'.

PUSHBITS_MATRIX_USERNAME: 'your/matrix/username' # The Matrix account from which notifications are sent to all users.

PUSHBITS_MATRIX_PASSWORD: 'your/matrix/password' # The password of the above account.

volumes:

- /etc/localtime:/etc/localtime:ro

- /etc/timezone:/etc/timezone:ro

- ./data:/data

</code></pre>

<p>In this example, the configuration file would be located at <code>./data/config.yml</code> on the host.

The SQLite database would be written to <code>./data/pushbits.db</code>.

<strong>Don't forget to adjust the permissions</strong> of the <code>./data</code> directory, otherwise PushBits will fail to operate.</p>

<h2 id="usage">Usage</h2>

<p>We provide <a href="https://github.com/PushBits/cli">a little CLI tool called pbcli</a> to make basic API requests to the server.

It helps you to create new users and applications.

You will find further instructions in the linked repository.</p>

<p>At the time of writing, there is no fancy GUI built-in, and we're not sure if this is necessary at all.

Currently, we would like to avoid front end development, so if you want to contribute in this regard we're happy if you reach out!</p>

<p>After you have created a user and an application, you can use the API to send a push notification to your Matrix account.</p>

<pre><code class="language-bash">curl \

--header "Content-Type: application/json" \

--request POST \

--data '{"message":"my message","title":"my title"}' \

"https://pushbits.example.com/message?token=$PB_TOKEN"

</code></pre>

<p>Note that the token is associated with your application and has to be kept secret.

You can retrieve the token using <a href="https://github.com/PushBits/cli">pbcli</a> by running following command.</p>

<pre><code class="language-bash">pbcli application show $PB_APPLICATION --url https://pushbits.example.com --username $PB_USERNAME

</code></pre>

<h3 id="message-options">Message options</h3>

<p>Messages can be specified in three different syntaxes:</p>

<ul>

<li><code>text/plain</code></li>

<li><code>text/markdown</code></li>

</ul>

<p>To set a specific syntax you need to set the <code>extras</code> parameter (<a href="https://gotify.net/docs/msgextras#clientdisplay">inspired by Gotify's message extras</a>):</p>

<pre><code class="language-bash">curl \

--header "Content-Type: application/json" \

--request POST \

--data '{"message":"my message with\n\n**Markdown** _support_.","title":"my title","extras":{"client::display":{"contentType": "text/markdown"}}}' \

"https://pushbits.example.com/message?token=$PB_TOKEN"

</code></pre>

<p>HTML content might not be fully rendered in your Matrix client; see the corresponding <a href="https://spec.matrix.org/unstable/client-server-api/#mroommessage-msgtypes">Matrix specs</a>.

This also holds for Markdown, as it is translated into the corresponding HTML syntax.</p>

<h3 id="deleting-a-message">Deleting a Message</h3>

<p>You can delete a message, this will send a notification in response to the original message informing you that the message is "deleted".</p>

<p>To delete a message, you need its message ID which is provided as part of the response when you send the message.

The ID might contain characters not valid in URIs.

We hence provide an additional <code>id_url_encoded</code> field for messages; you can directly use it when deleting a message without performing encoding yourself.</p>

<pre><code class="language-bash">curl \

--request DELETE \

"https://pushbits.example.com/message/${MESSAGE_ID}?token=$PB_TOKEN"

</code></pre>

</article>

</div>

</div>

</main>

</div>

Made with

Material for MkDocs

</a>

</div>

</a>

</div>

</footer>

</div>

</div>

</body>

</html>

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls