Today's Deep-Dive: hedgedoc

All right, welcome back, everybody.

Today, we're going to do a deep dive into HedgeDoc.

Ooh, excited.

It's exciting, right?

So HedgeDoc is a collaborative markdown editor.

Sounds interesting.

Yeah.

And we have a bunch of different sources today.

We've got excerpts from their FAQ, their about page, and even a peek into his history.

Ooh, fun.

Yeah.

So think about it this way.

Imagine you want to use a tool that lets you write and work together

online seamlessly and then HedgeDoc pops up.

Like what do you absolutely need to know about them?

Yeah.

The need to knows.

Yes, exactly.

That's what we're going to uncover today.

We're like HedgeDoc detectives.

Yes.

We're on the case.

Got to get the clues.

Exactly.

So the first clue is figuring out what it actually is.

Right.

We got to start with the basics.

Yeah.

What is this thing?

And their about page says it's like Google docs for markdown lovers.

Ooh, I like that.

Yeah.

It's a very catchy tagline, but I'm like, okay, but what is it really?

What's the deeper story?

Yeah.

What's the deeper story?

So imagine a platform where you can write and collaborate in real time, just

like Google docs, but with the power and the simplicity of markdown.

Right.

Okay.

That's HedgeDoc in a nutshell, but it gets really interesting here.

It's also open source and self-hosted.

Okay.

Hold on.

Open source.

Yes.

So like anyone can see the code tinker with it, even build their own versions

if they want to.

Absolutely.

It's all about transparency and community collaboration.

And the self-hosted part means that you or your organization could

host it on your own servers.

Okay.

So you don't have to rely on big tech companies to store your data.

So it's like having your own little like writing and collaboration hub with

like total control over your data.

That's a big deal.

I feel like these days.

It is a big deal, especially with all the concerns about data privacy and

security these days.

Right.

Exactly.

Okay.

So we've got like the control aspect, but let's not forget about the

features, like what can you actually do with this thing?

Okay.

Well, first off, it's all web-based.

Okay.

So no need for downloads or installations or any of that.

Oh, nice.

Convenient.

Super convenient.

You can access it from anywhere as long as you have an internet connection.

Perfect.

And remember that real-time collaboration we were talking about?

It's built right in.

You can have multiple people working on the same document at the same time.

So no more like emailing drafts back and forth or trying to

merge like different versions.

Well, more of that.

It just streamlines the entire process.

Awesome.

Okay.

Yeah.

So that's a big plus.

What else?

Well, it also has a presentation mode.

Oh, wow.

So you can turn your notes into slides for sharing.

That's fancy.

It is quite fancy and it even supports graphs and diagrams.

Oh, cool.

Yeah, which is perfect if you're a visual learner or if you just want to add some,

you know, yeah, some spice, some pizzazz to your presentation, a little razzle

dazzle.

Okay.

So it sounds like a one-stop shop.

It really is for collaborative writing presenting.

But I gotta say something about the name HedgeDoc.

It's a little unusual.

Yeah.

You've got a keen eye for detail there.

Where'd it come from?

Ria?

Yeah.

There's a whole backstory there.

It wasn't always called HedgeDoc.

Really?

In fact, it's gone through a few different name changes.

Ooh, I love OriginStory.

Yeah.

Each one marks a different step in its evolution.

Okay.

Let's rewind the tape, see where it all began.

All right.

So picture this.

It all started with a platform called HackMD.

HackMD.

Does that ring a bell for anybody?

It might.

I feel like I've heard that before.

It was pretty popular in the tech community.

It was this awesome collaborative markdown platform.

Okay.

But eventually it's split into two branches, a community version and an

enterprise version.

Ah, it's like a family tree branching out.

Exactly.

And to avoid confusion, the community driven version was renamed Coding MD.

Coding MD.

Okay.

So Coding MD was essentially the open source community driven offspring of HackMD.

You got it.

But the story doesn't end there.

Oh no, there's more.

The community decided to take things a step further.

Okay.

They decided to create a completely independent project.

Wow.

Based on Coding MD and that my friend is how HedgeDock was born.

So HedgeDock is like the grandchild of HackMD carrying on the legacy of open

source collaboration, but forging its own path.

Yes.

That's pretty cool.

It is really cool.

And that spirit of community really permeates everything about HedgeDock.

Yeah, I love that.

It's not just about using a tool.

It's about being part of a movement toward more transparent, collaborative

and user driven software development.

I'm here for it.

Me too.

Okay, so that's all really cool.

But let's get down to brass tacks.

Okay.

People have questions about HedgeDock.

Sure.

Like those practical, everyday concerns that might come up when you're

thinking about using it.

That's where these FAQs come in handy.

Exactly.

And we have some, they're a treasure trove of real world questions and

thankfully answers.

We need those.

Yes.

So let's dive into some of these and see what we can clear up.

Let's do it.

What are some of the common questions that people have about HedgeDock?

So one that we see a lot is, can I run multiple HedgeDock instances on the

same database?

Okay.

And the answer is unfortunately, no.

That's a bummer.

Why not?

I know.

It seems like it'd be handy.

Yeah.

Like different teams, different projects.

Yeah.

For different projects.

Yeah.

But it seems that the HedgeDock server process is not entirely stateless.

Okay.

So each instance needs its own space to avoid conflicts and potential data loss.

They recommend a system that ensures that one instance is always running

for high availability setups.

Okay.

So you minimize any downtime.

Right.

Okay.

So multiple instances on the same database.

Yeah.

No go.

No go.

It's a no for me.

Okay.

What else are people wondering about?

Another common question is about the missing PDF export feature.

Oh, really?

Yeah.

So you can't like download your notes as a PDF easily anymore.

Not as easily as you used to be able to.

What happened?

Well, they used to have a PDF export feature, but it relied on something

called a headless chromium instance.

Okay.

And turns out that created some potential security vulnerabilities.

Oh, no.

So they decided to pull the feature for now to prioritize user safety.

Okay.

So they're like hitting the pause button.

Yeah, they're hitting pause to make sure everything is secure and sound.

Better safe than sorry.

Exactly.

For now, they suggest using your browser's print to PDF function as a

workaround, but they are working on bringing back a secure PDF export option.

Awesome.

Glad to hear that.

Yeah.

So speaking of security, there are a couple of questions about embedding.

Yes.

So why can't you embed like certain PDFs or even HedgeDoc notes on

other pages using iframes?

It all comes down to security again.

It seems to be a recurring theme.

Security first.

Yes.

Many servers are set up to prevent their content from being embedded on other

websites to avoid things like clickjacking or cross site scripting attacks.

So it's not that HedgeDoc is being difficult.

It's actually the server where that content live saying, Nope, not on my watch.

Right.

Okay.

They do provide options to enable embedding if you absolutely need to do that.

Okay.

But they strongly advise against it.

Okay.

They even highlight specific configurations you would need to adjust.

Getting technical.

They can get a little technical.

All right.

So proceed with caution.

Yes.

Do your research and do your research if you are going to try to embed.

Exactly.

All right.

What other like FAQ gems do we have?

Let's talk about uploads.

Okay.

Sometimes people run into issues with uploading images or files getting stuck.

Yes.

I hate when that happens.

I know.

It's frustrating.

Very frustrating.

But more often than not, it's a simple fix.

Okay.

The culprit is usually a missing or incorrect domain setting in the configuration.

Uh, like a typo in the web address.

Exactly.

Easy mistake to make.

Yeah.

Thankfully easy to fix.

They have a whole section on reverse proxy configuration that explains this in detail.

So don't panic.

Don't panic.

It's all good.

If you run into that issue, you got this.

Okay.

Any other common hiccups?

Yeah.

One more that often trips people up is related to migrations.

Okay.

Sometimes HedgeDoc might fail to start properly because of migration issues

stemming from older versions.

So they had some bugs that didn't always record whether a migration was

successfully completed.

When you say migrations, you mean like...

Like moving your data from an older version of HedgeDoc to a newer one.

Gotcha.

Okay.

And they've created a dedicated troubleshooting guide for this specific issue.

Okay.

So you're not alone.

If you run into it, there's a clear path to resolution.

That's good.

It's reassuring to know that they've got these resources to help you.

Yeah.

So we've covered a lot.

We have.

We've got the features.

Yes.

We've got the name game.

We even tackled some common concerns.

Yeah.

But let's take a step back.

Like, what's the bigger picture here?

Yeah, that's the real question.

What makes HedgeDoc truly stand out?

Because it's more than just a set of features.

It represents like a philosophy, a shift in how we think about online collaboration.

Okay.

I'm intrigued.

Let's explore that.

What is so unique about HedgeDoc's approach?

Well, it really flips the script on traditional software models.

Okay.

It's not about a company controlling your data.

Right.

And dictating how you collaborate.

Right.

It's about empowering users to take ownership.

Okay.

So with its open source nature, anyone can contribute to its development,

shape its future direction.

So it's kind of like a community garden.

Yeah.

But for software.

I love that analogy.

Where everyone's pitching in to cultivate something awesome.

Exactly.

And the self-hosting aspect adds another layer of control.

Right.

You're not entrusting your data to a third party.

Okay.

You're holding the keys, deciding where it resides, who has access.

It's like having your own little digital vault for all your collaborative projects.

Yeah.

For your secret documents.

Top secret.

And especially in an age where data breaches and privacy concerns are

constantly making headlines.

Exactly.

It's so refreshing to see a platform that prioritizes user control and transparency.

For sure.

But how does this translate to like the everyday user?

Yeah.

Like why should they care about HedgeDoc?

Well, let's say you're working on a project with a team.

Okay.

Could be a report, a presentation, brainstorming for a new product launch.

Yeah.

HedgeDoc provides this virtual space where everyone can contribute in real time.

Right.

See each other's edits as they happen and build upon ideas collaboratively.

So it's like having a shared whiteboard that everyone can access.

Exactly.

Yeah.

No matter where they are.

So no more juggling multiple versions of a document or...

Exactly.

... struggling to merge everyone's changes.

It just streamlines that whole process.

Right.

And because it uses Markdown, which is a very simple, intuitive markup language,

the focus stays on the content, not on complex formatting.

Okay.

It's all about getting those ideas down quickly and efficiently.

I mean, I'm all about simple and efficient.

So that's a huge plus for me.

Me too.

And I love that it goes beyond just text.

Right.

You mentioned presentation mode.

Yes.

And the support for graphs and diagrams.

Absolutely.

So you can elevate that collaboration beyond just words.

Imagine seamlessly transitioning from brainstorming in a shared document to

presenting those ideas in a visually engaging way, all within the same platform.

Yeah.

Yeah.

I'm starting to see the bigger picture here.

Good.

It's not just collaborative writing.

Yeah.

It's like collaborative knowledge creation.

It is.

From brainstorming and drafting to presenting and sharing and all this with

a strong emphasis on user control, transparency, community involvement.

That's HedgeDoc.

Yeah.

It's like a breath of fresh air.

I feel like in a digital landscape dominated by closed platforms, data

hungry corporations, but let's not get ahead of ourselves.

What about the nitty gritty technical details?

Let's get into it.

We talked about self-hosting, which might sound intimidating to some.

I can see that.

Is it really feasible for like individuals or small teams?

Yeah.

Is it realistic to set up their own HedgeDoc instance?

It's a great question and an understandable concern.

Yeah.

But here's the good news.

HedgeDoc has been designed with accessibility in mind.

Okay.

It has very low system requirements.

Okay.

Meaning it can run smoothly on a variety of hardware.

So you don't need like a massive server farm to host your own HedgeDoc.

Nope.

And the community has put together excellent documentation and guides to walk

you through that set up process step by step.

It's not as daunting as it might seem initially.

That's good to hear.

It seems like the community is really dedicated to making it accessible,

regardless of your technical expertise.

For sure.

Okay.

So we've established that HedgeDoc is user friendly.

Yeah.

Even for self-hosting.

Right.

But are there any limitations we should be aware of?

Hmm.

Good question.

Any features it's missing that might be deal-breakers for some users?

Well, we already talked about the temporary absence of PDF export.

Right.

That's on their roadmap for the future and some users might miss the

extensive plugin ecosystems that other platforms have.

Right.

HedgeDoc's plugin support is still kind of evolving, but it's an area

they're actively working on.

So if you're like someone who loves customizing their workflows with tons of

plugins, HedgeDoc might feel a bit limited at the moment.

Yeah, that's fair to say.

However, the core functionality is so robust and well-designed that it might

not even be a major drawback for a lot of users.

And the beauty of open source is that anyone with the technical skills can

contribute to expanding that plugin ecosystem.

Right.

Exactly.

So it's all about community driven innovation, filling those gaps, shaping

the platform to meet everyone's needs.

It's beautiful.

Yeah.

Okay.

I'm feeling pretty good about HedgeDoc so far, but let's look ahead.

Okay.

Where is this platform headed?

Yeah.

Where is it going?

What's in store for the future of HedgeDoc?

It's exciting to think about the possibilities, right?

Yeah.

We don't have a crystal ball or anything, but we can kind of look at

trends in the direction of the project and make some educated guesses.

Okay.

And I think it's safe to say that HedgeDoc is on an upward trajectory.

All right.

You've got me on the edge of my seat.

Okay.

What kind of trends are we talking about?

So for one, they're actively developing HedgeDoc 2.0, which is a

complete rewrite of the platform using TypeScript.

Okay.

So that signifies a commitment to continuous improvement, modernization,

and staying ahead of the curve.

So they're not just like resting on their laurels.

No.

All right.

They're like actively pushing boundaries, making it even better.

They're pushing it to the limit.

Love it.

And with that increasing emphasis on data privacy and security, I

think HedgeDoc's self-hosting capabilities are going to become even

more appealing to individuals and organizations.

Especially as people are like waking up to the importance

of controlling their data.

Exactly.

So HedgeDoc offers a solution that aligns perfectly with that.

Yeah.

It's like they anticipated this shift.

Yeah.

Yeah.

Toward data consciousness.

Giving users the tools to like take back control of their digital lives.

You got it.

That's pretty forward thinking.

It really is.

Yeah.

And as the community keeps expanding, I expect we'll see even more innovative

features, integrations, use cases emerge.

So it's like a snowball effect.

Like the more users leads to more contributions, which leads to like

a richer, more powerful platform.

It's beautiful.

Yeah.

It's an exciting cycle to be a part of.

I know.

Right.

And it really challenges us to think beyond traditional

models of software development.

Right.

What if this community driven approach becomes the norm?

Yeah.

What if user empowerment becomes the driving force behind technological

innovation, Headstock kind of offers a glimpse into that potential future.

Yeah.

It's a powerful vision and I have to admit it's contagious.

It is contagious.

Okay.

So we've explored the what, the why and the future of Headstock.

We really have.

But before we wrap up, I want to leave our listeners with something to ponder.

Okay.

Love that.

A question just to spark their curiosity and encourage them to dive deeper.

I'm ready for the question.

All right.

So my question is, if Headstock continues to grow and evolve, how might

it disrupt traditional models of knowledge sharing and collaboration?

Wow.

Will it lead to more decentralized community-driven approaches to knowledge creation?

Right.

Will it empower individuals and small teams to compete with larger institutions?

These are great questions.

Yeah.

These are the kinds of questions I hope our listeners will

contemplate as they explore Headstock.

I love that question.

It challenges us to think about the broader societal implications.

Yeah.

It's not just about a tool.

Right.

It's about, like you said, a potential paradigm shift.

Yeah, exactly.

Well, I think we've reached the end of our deep dive into the world of Headstock.

It has been a fascinating journey.

It really has.

And I hope our listeners have gained some valuable insights into this

remarkable platform.

I hope so too.

We encourage you to check out the links in the show notes, of course.

Always, always.

You can try out the Headstock demo, explore their documentation,

and even join the community.

Join the party.

Yeah.

And who knows?

Who knows?

Maybe you'll become part of the Headstock story.

You could be a part of history.

Contributing to its evolution.

Yeah.

And helping to shape the future.

Shaping the future.

Of collaborative knowledge creation.

Until next time, keep those minds curious.

Yes.

Happy collaborating everybody.

Happy collaborating everybody.