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

fix(docd): Update Subdirectory Documentation (#1363) 

Signed-off-by: Jef Oliver <jef@eljef.me>
Co-authored-by: kolaente <k@knt.li>
Reviewed-on: vikunja/api#1363
Co-authored-by: Jef Oliver <jef@eljef.me>
Co-committed-by: Jef Oliver <jef@eljef.me>
This commit is contained in:
Jef Oliver 2023-02-03 08:41:36 +00:00 committed by konrad
parent 5d242f7e54
commit cb96590611
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_BASE` variable specified.
``` ```
pnpm vite build --base=/SUBPATH VIKUNJA_FRONTEND_BASE=/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_BASE` 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.