-
-
Notifications
You must be signed in to change notification settings - Fork 182
FAQ
If you can't find what you are looking for here, please check the Q&A Discussions and feel free to create a new discussion!
There are multiple ways of using Excalith Start Page, allowing you to chose the ones suit your needs best. You can find more information on Getting Started page.
Here are some comparisons
Preview Version | Fork | Docker |
---|---|---|
No techie setup needed. However, it always uses latest version, so it can break your local configurations time to time due to new features. | Uses the version you forked until you want to update with upstream. Will not break anything automatically. | Uses the version of the image until you want to update. Will not break anything automatically. |
You need to be online to use the page. | This is just the source, you will need to build or deploy in order to use. | Docker will host locally using the optimized build just like you would do with a fork. |
Loading resources depends on your connection speed. | You will have total freedom: create docker images, deploy to server or serve locally. | It will use your computer as a server, faster than online method. |
If you want to edit only the configuration, you can simply use config edit
command and change anything provided there. You can find instructions about customizing on How To Customize wiki page.
If you used Docker bind volumes while composing, you can change the configurations from your file system directly. However, this won't apply for the default volumes where they persist within Docker.
However, if you want to change the source code (aka. the files), you cannot do that in your Docker container since it serves an optimized build. Instead, you should fork
this git repository (not the docker image from registry) and make your changes within the source code.
It is intended this way, following best practices to keep things tidy and respect your space. The goal is to minimize any interference with your own mounted directory, putting only place the essential configuration file needed for the app to run.
If you want to download assets and / or themes from the original repository, please check out this Q&A discussion for some scripts to do this automatically.