eljef
/
api
forked from vikunja/vikunja
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(doc): Update Subdirectory Documentation 

* This updates subdirectory documentation to denote the
  requirement of a trailing slash.
* Reflects change introduced in frontend/2964.

Signed-off-by: Jef Oliver <jef@eljef.me>
This commit is contained in:
Jef Oliver 2023-01-17 08:44:33 -08:00
parent 3b1887e438
commit 6383690003
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/content/doc/setup/subdirectory.md
View File

@ -17,15 +17,27 @@ However, you can still run it in a subdirectory but need to build the frontend y
First, make sure you're able to build the frontend from source.
Check [the guide about building from source]({{< ref "build-from-source.md">}}#frontend) about that.
Then, run
### Dynamicly set with build command
Run the build with the `VIKUNJA_FRONTEND_SUBPATH` variable specified.
```
pnpm vite build --base=/SUBPATH
pnpm workbox copyLibraries dist/
VIKUNJA_FRONTEND_SUBPATH=/SUBPATH/ pnpm run build
```
Where `SUBPATH` is the subdirectory you want to run Vikunja on.
### Set via .env.local
* Copy `.env.local.example` to `.env.local`
* Uncomment `VIKUNJA_FRONTEND_SUBPATH` and set `/subpath/` to the desired path.
After saving, build Vikunja as normal.
```
pnpm run build
```
Once you have the build files you can deploy them as usual.
Note that when deploying in docker you'll need to put the files in a web container yourself, you
can't use the `Dockerfile` in the repo without modifications.