Ein grundlegendes Archivierungstool für Discourse

Archivierungstool mit Codex Mai 2026 aktualisiert

Es scheint ziemlich knifflig zu sein, eine gesamte Discourse-Website in eine statische Version zu überführen. Laut diesem Beitrag von Jeff Atwood ist dies „viel schwieriger, als man denkt“. Es scheint auch, dass dies für das Discourse-Team keine Priorität hat, was völlig verständlich ist.

Für meine Zwecke stellte ich jedoch fest, dass ich wirklich eine Möglichkeit benötigte, einfache, statische HTML-Versionen meiner Discourse-Sites zu erstellen. Ich nutze Discourse seit einigen Jahren als Diskussionsforum beim Unterricht meiner Mathematikvorlesungen an der Universität. Daher ziehe ich alle paar Monate ein oder zwei Sites zurück und starte ein oder zwei neue. Offensichtlich haben die Diskussionen auf den zurückgezogenen Sites einen Wert, sodass ich wirklich eine Möglichkeit benötigte, sie zu archivieren. Letztendlich entschied ich mich, mein eigenes Tool zu entwickeln.

Die Grundidee ist einfach: Verwenden Sie die Discourse-API, um die Site zu durchsuchen, die bearbeitete Version jedes Beitrags abzurufen und diese in HTML zu überführen. Das Tool konzentriert sich weitgehend auf meine eigenen Bedürfnisse als Mathematikprofessor an einer Universität, der kleine Discourse-Foren zur Unterstützung meiner Mathematikvorlesungen nutzt. Daher sollte mathematischer Inhalt wie f(x)=e^{-x^2} automatisch mit MathJax V4 gesetzt werden, und mit Backticks umschlossene Code-Blöcke, die als sage gekennzeichnet sind, werden in aktive Sage-Zellen umgewandelt.

Wenn Sie interessiert sind, können Sie

einsehen.

Hinweis

Die Aktualisierung des Archivierungstools wurde weitgehend mit Codex durchgeführt.

We’re definitely interested in this, because sometimes you want to turn off all the fancy hosting and databases and render out a set of static HTML pages for permanent long term archiving with zero security risk.

With the meta topic, others can follow along and edit / contribute as needed.

You can also use our basic HTML version for archiving: this topic in HTML.

You can get this version using a crawler user agent.

Maybe this + recursive wget or similar can help you.

Yes, those links are gone, but it’s all summarized on this new page. Also, the output of the code as applied to this DiscourseMeta is now here. I even put it up on GitHub so maybe someone will get interested.

I’d like to edit the original post, but I seem to be past the edit window.

Incidentally, I do think that httrack works much better than I originally thought but I still strongly prefer my version for two main reasons:

  • My code explicitly supports MathJax, which is essential for my work.
    (I’ll probably need to update my code to work with the new MathPlugin sometime)
  • I’ve got much more control over what get’s downloaded and how it’s displayed. For example, I don’t like the way that httrack output points to user links, even if not downloadedl

I’m hosting a forum that is currently, in its third iteration, running Discourse. Our last two forums were (I think, phpbb2 or something like that). I have resolved to archive them using Discourse, so that:

  1. I scan the phpbb2 database into Discourse (there’s a migration tool)
  2. I create a static HTML archive using Discourse.
  3. I put up the static HTML archive into public use (preferably in the same place where our dynamic forum running Discourse is).

According to the first message

There are no user pages or category pages

Could it be somehow advanced so that creating category views would be also possible?

Also, any help on how to use the Jupyter notebook thing? First time I hear of this…

@Silvanus Can you indicate a live discourse site that you want to archive? I’d be glad to try it out.

Also, have you tried httrack? I think that a command as simple as httrack yoursiteurl might work quite well.

I’m still in the phase 1 (phpbb2 > phpbb3 > discourse) of my archival, so no site yet. After I’ve managed the phpbb conversion, I’ll get back to this. It feels very, very hard. Been trying to install phpbb3 for a while now, but I get some weird problems all the time. :frowning:

I’ll have to try that httrack, thanks.

@Silvanus Well, I noticed that you point to the forum at https://uskojarukous.fi/ on your Profile page; I went ahead and created a couple of archives of that. You can (temporarily) take a look at the results here:

Here are a few comments:

  • I definitely like my version better; no surprise there because I designed it the way I want it to look.
  • The front page of the httrack version doesn’t look so great simply because that’s what the escaped fragment version looks like.
  • I think it might make sense to start httrack at a subpage to generate something like this.
  • It wouldn’t be too hard to make my archival tool grab the categories; I might do that for the next iteration.
  • My code adds MathJax to every page because my forums are mathematical. I should probably try to detect if MathJax is necessary. I’m guessing your forum doesn’t require it.

The httrack command

The httrack version was generated with a command that looks like so:

httrack https://uskojarukous.fi -https://uskojarukous.fi/users* -*.rss -O uskojarukous_arxiv -x -o -M10000000 --user-agent "Googlebot"
  • The -https://uskojarukous.fi/users* -*.rss prevents httrack from downloading files matching those patterns.
  • The -x -o combo replaces both external links and errors with a local file indicating the error. So, for example, we don’t link to user profiles on the original that weren’t downloaded locally.
  • The -M10000000 restricts the total amount downloaded to 10MB. There appears to be some post processing and downloading of supplemental files that makes the total larger than this anyway.
  • The --user-agent "Googlebot" should not be necessary if the forum is powered by a recent version of Discourse.

The archival tool code

For the most part, the archival tool should run with minimal changes. I run it within a Jupyter notebook but the exact same code could be run from a Python script with the appropriate libraries installed. Of course, you need to tell it what forum you want to download. The few lines of my first input look like so:

base_url = 'https://uskojarukous.fi/'
path = os.path.join(os.getcwd(), 'uskojarukous')
archive_blurb = "A partial archive of uskojarukous.fi as of " + \
  date.today().strftime("%A %B %d, %Y") + '.'

Later, in input 6, I define max_more_topics = 2. Essentially, that defines a bound on k in this code here:

'/latest.json?page=k'

But again, there should be some changes made to the code to get it to work for non-mathematical forums.

Very cool, thank you for all the clarifications. Just a quick note, it seems that your tool can’t handle sub-categories (which is why many of the messages seem to be without a category).

@Silvanus Yes, I think you’re absolutely right about the sub-category thing. Thanks - I had wondered about that.

@mcmcclur: as you already realized, I’m the admin of said forum, which is the third of our forums. When we did technological jumps, we didn’t migrate, but started from scratch, and the older forum was archived. The last two forums are in SMF format - but I finally managed to start converting them into Discourse format! :slight_smile:

So, our forum had a public area and a closed area. I’m thinking that the closed area (a few categories) should be archived, but closed off via a password gate. I noticed that the static paths are something like /t/TITLE/MESSAGEID/. This, if course, lends itself for thread-by-thread gating, but is slightly cumbersome - but, heh, I guess that’s what you get when archiving huge loads of stuff from a dynamic forum to a static archive… :slight_smile:

Nur ein paar Tipps für alle, die nach httrack-Tipps suchen (was für meine Zwecke hervorragend funktioniert).

  • Eine vollständige Liste der Befehlszeilen-Flags: HTTrack Website Copier - Offline Browser
  • Das Flag -s0 ignoriert die robots.txt (falls Sie ein Konto haben, das nicht von Suchmaschinen-Crawlern erfasst werden kann).
  • Wenn Ihre Website hinter einer Anmeldung liegt, können Sie eine .txt-Datei mit den Cookies (nachdem Sie sich angemeldet haben) mithilfe einer Chrome-Erweiterung wie cookies.txt herunterladen und diese im Verzeichnis ablegen, aus dem Sie httrack ausführen.

Ich verwende httrack über Cron, um ein offline Archiv unserer Discourse-Website zu erstellen. Allerdings wird der Benutzer, der sich unter httrack anmeldet, für jedes Thema als „Ansicht

Good point, where would this be intercepted @sam?

We have this method for tracking page views:

We have additional methods for tracking user visits which would be even harder to override.

We only store one page view per day per user, but I get that it can add up.

Hacking this out so certain users are not tracked would either require a plugin or some sort of daily query that nukes all the views by the user and remembers to also reduce views count from the topics table.

Hi all – just jumping in here to say that @mcmcclur’s code was exactly what I was looking for! So thank you very much for sharing :slight_smile:

I made a few small modifications (mainly additional code that makes sure to grab all posts in a topic, not just the first twenty) and the code is here: GitHub - kitsandkats/ArchiveDiscourse: Code for archiving a Discourse site into static HTML., forked from @mcmcclur’s original repo and stored as a python file instead of a Jupyter notebook.

I’m very happy with how it turned out. Thanks again!

Hallo, ich habe gerade den gesamten Thread durchgelesen und wollte fragen, ob dieses Tool funktioniert, wenn das Discourse-Forum hinter einem Login und einem Passwort geschützt ist. Wie müsste ich den Code anpassen, damit ich die Seite archivieren kann?

So wie der Code derzeit geschrieben ist, ist er nicht dafür ausgelegt, auf Materialien zuzugreifen, die eine Anmeldung erfordern. Das einzurichten sollte jedoch ziemlich einfach sein. Der Code interagiert über die Python Requests-Bibliothek mit der Discourse-Website, die Authentifizierung unterstützt. Es ist gut möglich, dass das Hinzufügen von auth=('user', 'pass') an den entsprechenden Stellen im Code alles ist, was erforderlich ist. Ich betreibe derzeit keine Discourse-Website, sodass ich das im Moment nicht testen kann.

httrack funktioniert bei mir nicht. Ich verwende:

httrack https://my-forums.org --user-agent "Googlebot"

httrack sieht vielversprechend aus, aber lange Forumsthreads mit mehreren Seiten sind unvollständig. Sobald ich auf „Seite 2

Python Requests verwendet automatisch .netrc für die Authentifizierung, falls erforderlich (es muss jedoch eine HTTP-Antwort mit 401 erhalten werden).

Ich habe mit wget gute Ergebnisse erzielt, einschließlich der Authentifizierung. Hier beschrieben:

https://meta.discourse.org/t/archive-an-old-forum-in-place-to-start-a-new-discourse-forum/13433/14