Impossible to edit files outside of root [Local Storage Mode]

[m4rrc0]

Hey.

I need to edit content files outside of the project root but the getIsPathValid function is preventing me to do so.

Is there an important reason to prevent this in local mode? I would think we are responsible to check (and validate if necessary) our paths ourselves when in local mode since it only impacts our file system...

If this validation step is kept as is, could we have an option flag to disable it manually? Maybe an options key could be added to the LocalStorageConfig and allow a options.bypassPathValidation = true to bypass the getIsPathValid function entirely or make it always return true.

I am happy to make a PR once a course of action has been accepted by the team.

Alternative methods tried and failed

I tried to symlink my external content folder to a local folder but it is not working either. Probably fs not following symlinks? I would consider this problem fixed if I could properly access a symlinked folder.

I even tried manually copying over the files but then I want to gitignore them and when I do I cannot access them any more. I tried fiddling with the Vite config but could not make keystatic 'unignore' files... I would not consider this problem fixed if I get this working... it is more like an band-aid.

[m4rrc0]

I have had a shot at a PR.

Instead of going for options.bypassPathValidation = true, I went with using the already existing pathPrefix. It was not used for local storage mode and is perfect for the usecase I describe.

It has been working great for me locally in my early testing.

[Greenheart]

What kind of tech stack are you using for your project?

I read #1432 and the localBaseDirectory refers to the property of APIConfig which is defined in

keystatic/packages/keystatic/src/api/generic.ts

Line 21 in 63c767b

localBaseDirectory?: string;

In order to use this option, you might need to update how Keystatic integrates with your framework.

Astro

Edit: See https://github.com/stefanprobst/astro-keystatic-tailwindcss/ for a good example of the following ideas:

For Astro, you can't use the default keystatic() integration in astro.config.ts since it doesn't support customising the APIConfig:

keystatic/packages/astro/src/index.ts

Line 4 in 63c767b

export default function keystatic(): AstroIntegration {

Instead, you need to add implement a custom Astro API route for Keystatic, and a UI route that renders the CMS frontend. You can use the exports from @keystatic/astro/api and @keystatic/astro/ui to achieve this. You can look at how the default integration is implemented to see that you need to add a page /pages/keystatic/[...rest].astro where you render the UI, and an API route /pages/api/keystatic/[...rest].ts where you export the API endpoint using export const ALL = makeHandler({ config: keystaticConfig, localBaseDirectory: '/path/to/your/local/basedir' })

Other frameworks

You likely need a similar solution in other frameworks too - see if there is a possibility to change the APIConfig, or otherwise manually create the API route and UI page.

Hope this helps! :)

[m4rrc0]

Thanks for the clean reply @Greenheart .
I'll be honest, I moved on and am not using Keystatic anymore so I won't be able to test the setup you mention. I hope it can be useful for others.

Since the issue seems to have a solution, I'll close it.
Thanks again.