Базовый инструмент архивации для Discourse

Инструмент архивирования обновлён с использованием Codex (май 2026)

Похоже, что сохранение всего сайта Discourse в статическом виде — задача довольно сложная. Согласно этому посту Джеффа Аткинсона, это «гораздо сложнее, чем можно подумать». Также не видно, чтобы это было приоритетом для команды Discourse, что вполне понятно.

Однако для моих целей мне действительно требовался способ генерации базовых статических HTML-версий моих сайтов Discourse. Я использую Discourse уже несколько лет в качестве форума для обсуждения вопросов при преподавании курсов высшей математики в колледже, поэтому каждые несколько месяцев я закрываю один или два сайта и запускаю новые. Очевидно, что обсуждения на закрываемых сайтах имеют ценность, поэтому мне действительно нужно было найти способ их сохранить. В конечном итоге я решил создать собственный инструмент.

Основная идея проста: использовать API Discourse для обхода сайта, получения обработанной версии каждого сообщения и преобразования её в HTML. Инструмент в значительной степени ориентирован на мои собственные потребности как профессора математики в колледже, который использует небольшие форумы Discourse для поддержки своих математических курсов. Таким образом, математический контент, например f(x)=e^{-x^2}, должен автоматически форматироваться с помощью MathJax V4, а блоки кода с тегом sage преобразовываться в активные ячейки Sage.

Если вам интересно, вы можете просмотреть:

Примечание

Обновление инструмента архивирования было выполнено в значительной степени с использованием Codex.

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:

Just a few tidbits for anyone else looking for some httrack tips (which works great for my purposes).

  • A complete list of command line flags: HTTrack Website Copier - Offline Browser
  • Using the -s0 flag ignores the robots.txt (if you have a non-spider-able account)
  • If your site is behind a login, you can download a .txt file of the cookie (once logged in) using a chrome extension like cookies.txt and place that in the directory you’re running httrack from.

I’m using httrack via cron to create an offline archive of our Discourse site. However, the user that is logging in under httrack gets marked as a “view” for each topic, giving super-inflated numbers of views for each topic (the cron runs every hour).

Is there a way to exclude a certain user from being recorded in the statistics / view stats for the site as a whole?

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!

Привет, я только что прочитал всю эту тему и хотел уточнить: работает ли этот инструмент, если форум Discourse защищён паролем и требует входа? Как нужно изменить код, чтобы я мог сделать архив сайта?

В текущем виде код не предназначен для доступа к материалам, требующим входа в систему. Однако настроить это довольно просто. Код взаимодействует с сайтом Discourse через библиотеку Python Requests, которая поддерживает аутентификацию. Вероятно, достаточно добавить auth=('user', 'pass') в соответствующие места кода. В данный момент я не запускаю сайт на Discourse, поэтому не могу это проверить.

httrack у меня не работает. Я использую:

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

httrack выглядит многообещающе, но длинные темы форума с несколькими страницами скачиваются не полностью. Как только я перехожу на «страницу 2», всё ломается. То есть:

  • file:///home/user/My%20Web%20Sites/my-forums/my-forum.org/t/forum-thread-title/83394658.html выглядит отлично (не подгружает внешние ресурсы), но
  • file:///home/user/My%20Web%20Sites/my-forums/my-forum.org/t/forum-thread-title/83394658.html?page=2 не работает.

Есть какие-нибудь предложения?

Может быть, httrack можно как-то попросить «использовать режим печати»?

Может быть, httrack можно попросить «добавлять /print в конец»?

Есть ли настройка user-agent, которая показывает всю тему форума на одной странице? Если нет, не могли бы вы добавить эту функцию? Вы уже реализовали режим печати. Большая часть уже готова. Осталось только добавить user-agent, который заставит сервер отдавать контент, сгенерированный для «режима печати», для краулера? Иначе, если вам не нравится идея с пользовательским user-agent для этой цели, как насчёт HTTP-заголовка или cookie, которые можно было бы использовать для этой цели?


ArchiveDiscourse улучшенная/форкнутая пользователем @kitsandkats тоже не работает у меня.


Не могли бы вы также рассмотреть возможность реализации /print для главной страницы и страниц категорий?


Цитирую сам себя в https://meta.discourse.org/t/i-dont-like-infinite-scrolling-and-want-to-disable-it/104660/3

(Временное) отключение бесконечной прокрутки (для некоторых user-agent) сделало бы возможным архивирование Discourse с помощью инструмента веб-архивирования httrack.

Библиотека Python Requests автоматически использует .netrc для аутентификации, если это необходимо (но для этого должен быть получен HTTP-ответ 401).

Я получил хорошие результаты с wget, включая аутентификацию. Описание здесь:

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