Go to file
Anas Rashid b7bdf9bed7 Move archived upstream docs to docs/upstream/
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 23:51:29 +02:00
deploy Diwan: make env config work, ur-PK locale, own-site links relative 2026-10-04 23:32:16 +02:00
DiwanRazor Rename Ganjoor -> Diwan throughout the code 2026-10-04 23:49:01 +02:00
docs Move archived upstream docs to docs/upstream/ 2026-10-04 23:51:29 +02:00
RMuseum Database name: museum -> diwan 2026-10-04 23:49:29 +02:00
.dockerignore Diwan: Urdu classical poetry fork of GanjoorService 2026-10-04 23:14:25 +02:00
.env.example Diwan: Urdu classical poetry fork of GanjoorService 2026-10-04 23:14:25 +02:00
.gitattributes Add project files. 2020-08-14 21:06:22 +04:30
.gitignore Diwan: Urdu classical poetry fork of GanjoorService 2026-10-04 23:14:25 +02:00
DiwanService.sln Rename Ganjoor -> Diwan throughout the code 2026-10-04 23:49:01 +02:00
docker-compose.yml Database name: museum -> diwan 2026-10-04 23:49:29 +02:00
Dockerfile Rename Ganjoor -> Diwan throughout the code 2026-10-04 23:49:01 +02:00
LICENSE Create LICENSE 2020-08-14 21:35:13 +04:30
README.md Rename Ganjoor -> Diwan throughout the code 2026-10-04 23:49:01 +02:00

دیوان · Diwan site

Diwan is a standalone project built on a fork of GanjoorService (GPL-3.0), the software behind ganjoor.net, adapted to serve classical Urdu poetry and prose from diwan-data.

Changes from upstream

  • Renamed Ganjoor → Diwan throughout: projects (DiwanRazor, DiwanService.sln), files, folders, classes, settings (Diwan: section), API routes (/api/diwan/...) and database tables (Diwan*). Real external addresses (ganjoor.net, github.com/ganjoor) are unchanged. Because table names changed, Diwan needs a fresh database; it can't reuse a Ganjoor one.
  • Removed Ganjoor/Persian-specific features: music (Spotify, Golha, Beeptunes, music index, song suggestions; DB models kept for a future Urdu version), Ganjoor's visit analytics, Turkish/Kurdish page options, abjad, Persian dictionary links. Random verse now picks from Diwan's own data.
  • Tajik removed: the TajikGanjoor site, Tajik API endpoints, services, export and transliteration are gone. Migration DiwanRemoveTajik drops their tables.
  • Branding: "گنجور" becomes "دیوان" throughout the site. Upstream is credited in the footer.
  • Urdu basics: pages are lang="ur-PK". The home page, footer and century groups (Hijri centuries, e.g. "تیرہویں صدی ہجری") are in Urdu. Deeper pages, such as admin and account pages, are still Persian.
  • Fonts: Noto Nastaliq Urdu by default, with a نستعلیق / نسخ switch (Noto Naskh Arabic) at the bottom left. The choice is remembered per browser.
  • Footer: links to Diwan-only services (Hafez divination, music index, etc.) are removed. Links to the Wikisource source, the data and the code are added.
  • Linux/Docker: Dockerfile + docker-compose.yml (SQL Server 2022, API, site, Caddy for HTTPS).
  • Config fixes so env vars work: the four places that read appsettings.json directly now also read environment variables. The JWT issuer follows RSecurityBackend:ApplicationName instead of the hard-coded "Diwan". deploy/entrypoint.sh copies the settings that RSecurityBackend reads only from appsettings.json (connection string, secret, app name, admin email) into the file at container start.
  • Links: ganjoor.net links to the site's own pages are now relative. Links to Diwan's other services (blog, audio, etc.) are left as they are.
  • Locale: ur-PK.

Deploy (Ubuntu/Debian x86-64, e.g. Vultr)

# 1. Docker
curl -fsSL https://get.docker.com | sh

# 2. Code + config
git clone https://github.com/anas-rashid/diwan.git && cd diwan
cp .env.example .env && nano .env      # domains, passwords, admin email

# 3. DNS: point SITE_DOMAIN and API_DOMAIN (A records) at the server, then:
docker compose up -d --build           # first build takes a few minutes
docker compose logs -f api             # wait for "Application started"

SQL Server needs about 2 GB of RAM. Use a plan with at least 4 GB in total.

Load the data

  1. Open https://SITE_DOMAIN/login and sign in with ADMIN_EMAIL and the password Test!123. The first login creates the admin account with that fixed password (RSecurityBackend's default; upstream's guide is wrong about this). Change it right away in the user panel.
  2. On the import page that opens (or Admin → مالی و سایت → درون‌ریزی دادهٔ عمومی), choose Internet URL and enter:
    https://cdn.jsdelivr.net/gh/anas-rashid/diwan-data@main/
    
  3. The import runs in the background (about 11k poems). Century groups are rebuilt automatically when it finishes.

Re-running the import adds new poems and leaves existing ones untouched, so it can be repeated after diwan-data's daily sync.

Update

git pull && docker compose up -d --build

Build locally (macOS/Linux)

cd RMuseum   # its global.json pins SDK 10.0.302; newer SDKs fail on some upstream Razor views
dotnet build RMuseum.csproj -p:EnableWindowsTargeting=true
dotnet build ../DiwanRazor/DiwanRazor.csproj -p:EnableWindowsTargeting=true

Running it needs SQL Server, so use the Docker setup above. SQL Server's image is x86-64 only.

License

GPL-3.0, same as upstream (see LICENSE). Data: see diwan-data.