vikunja/vikunja
6
43
Fork 73
Code Issues 150 Pull Requests 21 Packages Releases 32 Activity

fix(doc): Update Subdirectory Documentation
All checks were successful
continuous-integration/drone/pr Build is passing
Details

Browse Source 
* 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. 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. 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 VIKUNJA_FRONTEND_SUBPATH=/SUBPATH/ pnpm run build
pnpm workbox copyLibraries dist/
``` ```
Where `SUBPATH` is the subdirectory you want to run Vikunja on. 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. 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 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. can't use the `Dockerfile` in the repo without modifications.