Commit Graph

99 Commits

Author SHA1 Message Date
Joe Grigg
5568b07750 Ghost 6.0 update 2025-08-04 16:34:45 +01:00
Hannah Wolfe
94dbcd2ed5 Update .env.example 2025-08-04 19:01:46 +10:00
Hannah Wolfe
e488d40331 Updated comment in .env.example
Co-authored-by: Fabien O'Carroll <fabien@allou.is>
2025-08-04 19:01:46 +10:00
Hannah Wolfe
a27b16225f Updated comments in .env.example
- make it clear changing database credentials won't work
2025-08-04 19:01:46 +10:00
James Loh
e5bfa3c39b ActivityPub needs migrations before it can start
no ref

- If migrations haven't run AP can't start and will just crash so it needs to have finished before it can boot
2025-08-04 18:53:44 +10:00
Hannah Wolfe
84532112ed Updated comments and order in .env.example (#44)
- The main meaningful change here is commenting the GHOST_VERSION variable
- I've also reordered the blocks to prioritise things in the documented setup flow
- Made various changes to the comments for clarity
2025-08-04 08:47:43 +01:00
Hannah Wolfe
ffbd4ad070 Updated commented config in .env.example
- Changed mail to not be commented by default, as it is required
- Changed tinybird TO be commented by default, as it is optional
2025-08-04 09:48:43 +10:00
Hannah Wolfe
487291e346 Updated docker to RC.2 (#42)
ref: https://github.com/TryGhost/ghost-docker/pull/40

- Docker published RC2  on Friday I think
- Note 1: I just cut RC3, but that won't be available yet!
- Note 2: we prob need to rethink how we do versioning so we aren't pinning to exact versions
2025-08-03 22:37:57 +01:00
Chris Raible
a69f57bbeb Commented out the DATABASE_USER in .env.example` (#41) 2025-08-03 22:25:08 +01:00
Joe Grigg
3923cf81cb Updated missed v6 docker image update
This will only have an effect when the version isn't set in the .env file and we have it in the .env.example but did still need updating as the fallback.
2025-07-31 18:01:08 +01:00
Joe Grigg
7c1f9f39f9 Removed developer experiments configuration
Developer experiments used to be required in v5 but as we've switched to v6 they are no longer required to enable activitypub and traffic analytics.
2025-07-31 17:33:36 +01:00
Joe Grigg
9e7a3bf02a Updated to default to the latest (currently available on docker hub) 6.0
release candidate
2025-07-31 16:33:50 +01:00
Hannah Wolfe
9ef8319d83 Updated Caddyfile.example to clarify ActivityPub requirement (#37)
- ActivityPub only requires this redirect if you are using a www domain
2025-07-31 16:02:42 +01:00
Hannah Wolfe
82e6085bd7 Updated Caddyfile.example comments for clarity (#36)
- Added a section title to each block that can be uncommented, so that we can reference this in the documentation
- Removed the first comment line as that seems out of date and confusing
- Minor improvements to some language and spelling for clarity
2025-07-31 14:28:45 +01:00
renovate[bot]
4c3bc4e27a Update ghost/traffic-analytics Docker tag to v1.0.3 (#35)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-07-31 07:37:49 +00:00
renovate[bot]
b0db7bad3f Update ghost/traffic-analytics Docker tag to v1.0.2 (#33)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-07-24 01:44:11 +00:00
James Loh
871504e5ad Caddy: Fix non-www -> www placeholder
no ref

- In this redirect instance we're redirecting from `example.com` -> `www.example.com` so can actually use `{$DOMAIN}` here
- We can't in the first line of this block because Caddy doesn't (as far as I can currently tell) let us do a regex on it before putting it in to config
2025-07-15 21:22:33 +10:00
James Loh
c6211c9493 Caddy: Add note about redirect requirement for ActivityPub
no ref

- Our ActivityPub framework lets users set their AP username to index@example.com and have Ghost on www.example.com (ie instead of having their AP user be index@www.example.com)
- To do this users _must_ redirect from the non-www domain -> the www domain as the AP protocol will do lookups on the non-www path to validate and communicate to that username on the web
- Without this AP will fail since domains can't communicate with AP as there wont be redirects for them to follow
2025-07-15 21:22:33 +10:00
James Loh
ceac2ed1c2 Caddy: Add option to have a separate Admin domain
- Our setup docs recommend having Ghost Admin on a separate domain from the content domain
- This lets users optionally set this up if they want whilst continuing to align Admin <-> content domain through templates
2025-07-15 21:22:33 +10:00
James Loh
b2a3d75490 Caddy: Migrate redirects to placeholders
- We want customers to now copy the example Caddyfile so this still gives people the option but also makes it easier for customers who don't want to redirect themselves
2025-07-15 16:21:12 +10:00
James Loh
8d0d565df9 Caddy: Move to more templated approach
no ref

- The goal here is to be able to provide more functionality to self-hosters through snippets and other segmented config
- Some customers run Admin <-> content domains on separate ones which our current config doesn't support
- Our current config also hardcodes a www redirect which complicates setups when you don't have that domain setup or don't even want it
- Moving to a default template customers will have to copy which includes snippets allows us to update these later on without breaking peoples setups
2025-07-15 15:44:28 +10:00
James Loh
190a350bd5 AP: Proxy requests to shared Pro infra
no ref

- We're opening our AP setup to self-hosters as well now which saves them running the AP setup locally
2025-07-15 14:50:50 +10:00
Chris Raible
a752641576 Added traffic analytics configuration for file based salt store (#26)
ref https://linear.app/ghost/issue/PROD-2300/add-file-based-salt-store-for-self-hosters

In the analytics service, we generate user signatures based on a randomly generated salt per site_uuid. The salts are regenerated every day at midnight UTC so we can't pass a static value, and they need to be persisted throughout the day so the same user (based on IP and user agent) will generate the same signature in any given day.

We use an adapter-like pattern for the persistence of the salts — the default is a MemoryStore intended for local development, and we use Firestore in production. The MemoryStore appears to work well enough, but if the analytics service container is rebooted (i.e. during an update), all the salts from the current day will be lost, and it will skew the "unique visitors" and related metrics.

This PR adds the configuration to use a simple file based store for the salts, and a volume mounted into the Traffic Analytics service for persistent storage. This was the salts are persisted across container reboots, which avoids skewing the unique visitors metrics.

There are no additional setup steps required — all sites can use the same configuration, and the volumes are managed by docker compose.
2025-07-14 19:28:31 -07:00
renovate[bot]
aa46049727 Update ghost/traffic-analytics Docker tag to v1.0.1 (#28)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-07-15 02:26:42 +00:00
James Loh
b76e2a9ef4 Simplify initial setup by not include --profile arg
no ref

- As Chris notes this isn't actually required when doing the initial setup/mentioning the specific container you want to deploy
- This standardises us in just doing the `--rm run` command for all of them to keep everything nice and neat
2025-07-15 11:40:53 +10:00
James Loh
43891c65b5 Simplify TB initial setup
no ref

- By outputting the tokens in the format the `.env` file expects this greatly simplifies the initial setup by just makign it copy -> paste able
- This will mean users don't need to load up the UI and copy/paste tokens at all and can do the whole setup (after they've signed up for TB) from the CLI
2025-07-15 11:40:53 +10:00
Chris Raible
2f310b7ddc Added experimental script to automate fetching Tinybird tokens 2025-07-15 11:40:53 +10:00
Chris Raible
62ff21363f Added check for interactive mode in tinybird-login service 2025-07-15 11:28:49 +10:00
James Loh
e994f882b3 Tweak README with new installation steps 2025-07-14 16:21:08 +10:00
Chris Raible
90c56742bd Updated .env.example 2025-07-14 16:21:08 +10:00
Chris Raible
ee03de0a27 --wip-- [skip ci] 2025-07-14 16:21:08 +10:00
Chris Raible
26944f0a0a Updated Ghost config and Tinybird instructions to replace stats token with JWTs 2025-07-14 16:21:08 +10:00
renovate[bot]
880f6f1d29 Pin dependencies (#25)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-07-14 03:50:33 +00:00
James Loh
31f0c5a7d7 AP: Add docker images to auto-merge config
no ref

- Since we've created v1 now we can auto-merge new updates + pin digests
- This helps us ensure customers are running the specific version we want
2025-07-14 13:42:36 +10:00
James Loh
d06485b4d4 AP: Tag specific version along with migrate
- AP migration should be tagged along with the main AP instance to keep things in line
  - Renovate will now group them together so it bumps them at the same time in the same PR/commit etc to keep things aligned
- Moving to specific version pinning as well to make the renovate diffs clearer
2025-07-14 13:42:36 +10:00
Fabien O'Carroll
615b60fbb8 Bumped ActivityPub image to v1 2025-07-14 13:42:36 +10:00
renovate[bot]
c6ac2b7fd8 Pin ghost/traffic-analytics Docker tag to c93660c (#24)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-07-14 02:43:19 +00:00
James Loh
3b31abe46d TA: Setup auto-merge via Renovate
no ref

- This just makes updates simpler by having Renovate handle them for us via commits
- This means it'll auto bump all minor + match updates to TA images but _not_ major and it'll instead open up a PR
2025-07-14 12:39:35 +10:00
James Loh
63660bc207 TA: Pin to specific version
no ref

- This just makes the renovate difs clearer as to what version its bumping it to and from
2025-07-14 12:39:35 +10:00
Chris Raible
e526b047f3 Bumped traffic analytics to v1 2025-07-14 12:39:35 +10:00
James Loh
6dbf3e4b9a Fix tests not running on renovate branches
no ref

- This prevented renovate auto-merging the digest pin commits
2025-07-14 11:16:22 +10:00
renovate[bot]
19ebc03bdb Pin dependencies 2025-07-10 16:42:09 +10:00
James Loh
91a279fae9 Renovate: Slightly tweak config
ref

- Use best-practices instead of recommended as its the newer default
- Don't rate limit, just slam us
- Use branch merges over PRs where told to
- Pin all deps not just dev ones
- Everything else that was removed is now just included via `config:best-practices`
2025-07-10 16:36:51 +10:00
James Loh
e24893139b Pin to specific versions of packages to make renovate clearer 2025-07-10 16:30:23 +10:00
James Loh
c07d7cf7cf Don't pin AP Migration container as well 2025-07-10 16:26:23 +10:00
James Loh
3d8e896403 Restrict MySQL version to 8.0.x
no ref

- We officially only support MySQL v8, not 8.4 or 9, so can't go above this
2025-07-10 16:23:01 +10:00
James Loh
a081853573 Disable Major docker upgrades
no ref

- At the moment this would try and upgrade us to MySQL v9 which we don't officially support
2025-07-10 16:23:01 +10:00
James Loh
eac2324292 Start setting up initial renovate config 2025-07-10 16:23:01 +10:00
James Loh
afa3bb1ea9 Update AP with additional endpoints and make default proxying easier 2025-07-10 16:04:59 +10:00
Fabien O'Carroll
6e2f94f25d Updating ActivityPub paths
We do not support running on a subdirectory
We need to proxy webfinger requests for AP to work
2025-07-10 16:04:59 +10:00