Skip to content

Commit cc24140

Browse files
committed
📜 Aligned the stars in the Privateerr scrolls — lore enhanced, tech banished, and pirate soul fully charted
1 parent 2f823b6 commit cc24140

File tree

2 files changed

+30
-68
lines changed

2 files changed

+30
-68
lines changed

docs/github/calibre-web-automated.md

Lines changed: 16 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -6,59 +6,31 @@ icon: material/book-open-variant
66

77
# 📚 Calibre Web Automated
88

9-
> To read without order is to dine without table or chair.” – *Whitt & Folio*
9+
> It is a truth universally acknowledged, that a reader in possession of a large eBook collection, must be in want of a proper library.”
1010
11-
Welcome, dear reader, to a most distinguished Docker Compose configuration—one designed to bring civility and grace to your unruly eBook collection. Whether your digital shelves groan under the weight of Gothic thrillers or slightly scandalous fanfiction, **Calibre Web Automated** ensures every volume finds its proper place.
11+
Dear gentleperson,
1212

13-
## ✨ About This Repository
13+
Pray allow me to introduce **Calibre Web Automated**—a most elegant arrangement of software, bestowed upon the modern bibliophile to render their electronic tomes in perfect order and splendour. Where once there was chaos—files named “FinalFinal2.epub” strewn across devices—now arises a sanctuary of civility, wherein metadata shines and series are aligned as surely as carriages at a country ball.
1414

15-
This project deploys **Calibre Web Automated** using Docker Compose on Synology NAS or similar Docker-friendly estates. It integrates ingestion, curation, and serving of eBooks, all wrapped in automation and adorned with elegance.
15+
## 💫 A Most Suitable Match
1616

17-
Peruse the source here: [GitHub](https://github.com/scottgigawatt/calibre-web-automated)
17+
Whether your tastes incline toward swashbuckling fantasy, scandalous regency romances, or the occasional disreputable vampire memoir, this arrangement offers the promise of:
1818

19-
Special thanks to [Marius Hosting](https://mariushosting.com/how-to-install-calibre-web-automated-on-your-synology-nas) for their original setup guide—a lantern in the stacks.
19+
- Impeccably catalogued volumes—each more handsomely adorned than the last.
20+
- A refined user interface, suitable for both the drawing room and the dark parlour.
21+
- Automated processes so genteel, one scarcely need lift a gloved finger.
2022

21-
## 🪞 What's Included
23+
Indeed, should Lady Catherine de Bourgh herself desire access to the archives, one might confidently offer her a tablet and say, “Browse at your leisure, madam.”
2224

23-
| Apparatus | Description | Reference |
24-
|------------------------------|-----------------------------------------------------------------------------|-----------|
25-
| **Calibre Web Automated** 📘 | A Docker-based deployment for ingesting and displaying your library online. | [GitHub](https://github.com/crocodilestick/calibre-web-automated) |
25+
## 🛋️ Esteemed in All the Best Circles
2626

27-
## 🚀 Installation
27+
From the salons of macOS to the vast estates of Synology NAS, **Calibre Web Automated** has earned distinction amongst those of excellent reading habits and impeccable taste. It has been whispered (though never confirmed) that even Mr. Darcy himself employs it to manage his extensive collection of gothic poetry and botanical monographs.
2828

29-
```bash
30-
git clone https://github.com/scottgigawatt/calibre-web-automated.git /volume1/docker/calibre-web-automated
31-
cp example.env .env
32-
vim .env
33-
docker compose up -d
34-
```
29+
## 📖 An Invitation to Curiosity
3530

36-
Manual overrides are permitted for those inclined to live dangerously:
31+
If, dear reader, you find your heart stirred and your curiosity piqued, you are most cordially invited to promenade through the [Calibre Web Automated Repository](https://github.com/scottgigawatt/calibre-web-automated), where further marvels await.
3732

38-
```bash
39-
CWA_TAG="latest" docker compose up -d
40-
```
33+
May your libraries be vast and your metadata ever correct.
4134

42-
## 👒 Guidance and Rituals
43-
44-
Consult the sacred [Setup Guide](./SETUP.md) before embarking. Topics include:
45-
46-
- Docker networking and volume management
47-
- Synology firewall and container setup
48-
- Rituals for deploying with Container Manager
49-
50-
To skip it is to tempt literary chaos.
51-
52-
## 🪡 Confirmed Reading Rooms
53-
54-
Tested on:
55-
56-
- Synology DS1522+ and DS916+
57-
- DSM 7.2
58-
- macOS + Docker Desktop
59-
60-
If your estate supports Docker, this library shall thrive.
61-
62-
## 📖 License of Gentlefolk
63-
64-
Licensed under Apache 2.0. Forks, pull requests, and literary annotations most welcome.
35+
Yours in bibliophilic affection,
36+
**Calibre Web Automated**

docs/github/privateerr.md

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,29 @@ icon: material/anchor
66

77
# ⚓️ Privateerr ☠️
88

9-
Avast ye! Welcome aboard **Privateerr**, where Docker meets WireGuard in a glorious tangle of shell scripts, submodules, and seafaring VPN swagger.
9+
Ahoy, ye internet marauders! Welcome aboard **Privateerr**, the VPN vessel built for those who fancy their packets private and their connections cloaked in mystery. If yer browsing habits be nobody's business but yer own, you've dropped anchor in the right port.
1010

11-
## 🏴‍☠️ What's This Then?
11+
## 🏴‍☠️ The Ship’s Purpose
1212

13-
Privateerr be a devilishly clever containerized setup that builds and runs **Private Internet Access (PIA)** with WireGuard in tow. With it, ye generate a secure VPN config from scratch using only Docker, a `.env` file, and the salty determination of a seasoned deckhand.
13+
Privateerr be a dockerized contraption for conjuring up a stealthy VPN connection using **Private Internet Access (PIA)** and **WireGuard**. It brews up secure configs, keeps yer network traffic sailing the high seas unseen, and makes your Synology or macOS system the digital equivalent of a ghost ship.
1414

15-
At its heart lies a make-powered build system, a submodule of PIA's [manual-connections](https://github.com/pia-foss/manual-connections), and enough flags to sink a firewall.
15+
## 🔧 Built Like a Bloody Warship
1616

17-
Ye can inspect the full code o' conduct at [GitHub](https://github.com/scottgigawatt/privateerr).
17+
- Brewed from submodules and shell scripts more tangled than Davy Jones’ beard
18+
- Commands handled by a `Makefile` so slick, it practically swabs the deck for you
19+
- Tested in the rough waters of NAS and the foggy coasts of macOS
20+
- Keeps yer secrets stashed tight—nary a bit leaks from this hull
1821

19-
## 🔧 Capabilities Fit for a Captain
22+
## 🦜 Life Aboard
2023

21-
- ⚙️ Custom Docker image for WireGuard & PIA
22-
- 🗺️ Auto-generates a `wg0.conf` config file
23-
- 🧪 Tested on Synology and macOS waters
24-
- 🐚 Powered by Makefile targets for simple sailing
25-
- 🛠️ Modular with `.env` for personalized swashbuckling
26-
- ☁️ Ready for Gluetun and similar VPN containers
24+
Forget manual setup. With Privateerr, you shout `make up`, and the whole blasted thing hoists itself into motion like a crew o’ loyal deckhands.
2725

28-
## 🦜 Commands for Scallywags
26+
Ye want logs? Aye. Secrets? Guarded like buried treasure. Configs? Generated on the spot. This be VPN seafaring with style.
2927

30-
Use the `Makefile` to:
28+
## ☠️ Ye Be Warned
3129

32-
- `make build` – Build yer VPN image
33-
- `make pia-creds` – Provide yer secrets
34-
- `make up` – Set sail
35-
- `make logs` – Read the ship's log
36-
- `make help` – When the fog gets thick
37-
38-
## ⚠️ Mind the Kraken
39-
40-
Privateerr works best on Synology NAS and modern macOS shores, but other seas may hold strange beasts. Backup yer `.env`, protect yer `wg0.conf`, and never let your secrets fall into the hands of rival crews.
30+
Just because Privateerr runs like the wind on yer Synology schooner or Mac dinghy don’t mean it'll play nice in uncharted waters. Some ports may hide monsters. Always back up yer `.env`, guard yer `wg0.conf`, and don’t let Google catch wind of yer course.
4131

4232
---
4333

44-
☠️ *Adventure Awaits, Treasure Beckons. Fork if ye dare.* 🏴‍☠
34+
🏴‍☠️ *Sail quiet. Sail clever. And may your packets always be encrypted and your logs forever lost at sea.*

0 commit comments

Comments
 (0)