Commit Graph

15 Commits

Author SHA1 Message Date
Michael Clark
622d97c06f Upgrade docusaurus (#769)
> [!NOTE]  
> Important This will need a decent amount of testing of images, links,
sidebar, rss feed, etc

Upgrading Docusaurus to the latest.

- We can now use Mermaid diagrams
- It's supposed to have better performance
- It's actively supported (v2 wasn't)

Throughout this PR you'll notice 

- Formatting updates (they are required for the build process)
- Some CSS updates - some default styling was changed in the plugins we
use. The updates I've made should make the style near identical to
what's currently live
- Some updates & fixes to bring our docs in line with the v3 way of
writing

Overall, the docs should look the same.


## Known issues:

- The top page nav is flickering when clicking links in the top page
nav. It's happening on the main Docusuarus website
https://docusaurus.io/blog
- If we upgrade we'll have to accept it until they fix it on their end
2025-08-09 14:52:21 +01:00
fritz
6ae701b389 fix: mention ACTUAL_DATA_DIR is now dataDar in config (#758)
<!-- The process for Actual Budget Community Documentation pull requests
is documented at
https://actualbudget.org/docs/contributing/#submitting-a-pull-request
-->

Fixes
[actualbudget/actual/#5395](https://github.com/actualbudget/docs/issues/759)

**TL;DR** ACTUAL_DATA_DIR works as an env variable but not in the
config.json anymore. That comes up if you are migrating from the old
server to the new.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-08-06 21:48:12 +02:00
deathblade666
5671c598b9 Update https.md to include config.json creation through terminal (#662)
Add instructions for creating the config.json via a single terminal
command.

Reasoning - Assisted a MacOS deploy where they had everything setup
correctly but when they made the config.json file their instance
crashed, this was due to using the default GUI text editor which saved
the file as a .rtf and they renamed to .json. Doing this will leave
metadata in the file and actual wont know what to do with it causing an
infinite restart loop.

This addition provides a simple method to create the file without the
possibility of extra formatting bits causing issues
2025-04-22 07:45:51 -07:00
Michael Clark
88a9ba6cba Adding git bash as a prereq for Windows & renaming local install to Build from source (#664)
- Added desktop app to installation options "on your own machine" 
- For building from source
- Windows Users will need Git Bash so that they can build the web client
using the bash scripts.
  - Added a warning on the build from source page
- Reordered the _Build from source_ link to the bottom to encourage the
simpler options insted


![image](https://github.com/user-attachments/assets/d1dd032f-0482-444d-9e2d-2d0fe5cab980)


![image](https://github.com/user-attachments/assets/694f9303-d35e-44ba-b00e-2c6c3187bb88)
2025-03-19 21:08:25 +00:00
Michael Clark
bf8dd4d345 Update sync server config information (#646)
Making it clearer where the config.json file lives and adding it to the
repo move instructions.
2025-02-17 09:16:03 +00:00
ftbboy2115
804a09e4ad Update https.md (#619)
Clarified sentence - "If this is desired" -> "If access from the
internet is desired"
2025-01-27 08:09:07 -07:00
Matt Fiddaman
1faead2732 whitespace fixes (#522)
Removes double spacing and trailing whitespace.
2024-11-28 21:40:12 +01:00
bpaulien
bd2d1cce30 Update https.md (#514)
fixed wording
2024-11-27 19:01:17 +00:00
Ruben Olsen Lærk
2b66cabfe0 Fixed broken (relative) link in /docs/config/https to correctly point to /docs/config/reverse-proxies 2024-10-14 19:23:51 +02:00
Michael Clark
9c30602230 Update notes on self signed certificates for desktop app (#450)
Notes on mkcert when used with desktop app. 

Should resolve future questions like this one:
https://discord.com/channels/937901803608096828/1281484103580909621/1284432537682317365

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2024-09-14 15:08:28 +02:00
Ruben Olsen Lærk
0fca01f59e Activating HTTPs - header levels was wrong - no content has been changed. (#400) 2024-07-09 19:45:51 +01:00
qmph22
dd788aceae Update https.md (#335)
Reformatted the page, reworded some paragraphs, and added more
information about Docker for clarity.

After having to go through these steps myself, I found it might be
helpful to merge some of my suggested changes for others to view.
2024-03-22 07:48:39 +00:00
Blake Bryant
49ed1ba895 Add final step to enabling https on home server (#322)
Sounds like I'm not the only one that has run into this issue 😄

---------

Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2024-02-28 08:20:28 +00:00
Peter
941838c045 add reverse proxy config documentation (#267)
Hey, since I've been using Actual via Traefik for a few days now, I took
the time to add a little bit to the documentation in that regard. I hope
it fits so far. Please feel free to comment/improve anything.
2023-12-03 13:31:18 -07:00
Jed Fox
5d433c617e Reorganize page URLs to match the sidebar (#185)
Principles:

- lowercase URLs only
- kebab-case
- generally match sidebar structure
2023-06-12 15:20:06 -04:00