Skip to content
Can Cellek edited this page Jan 2, 2024 · 16 revisions

How Can I Use This?

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 current possible options;

Option Description
Online Online version is a tech preview. You can still use this, but not recommended. Please follow read the instructions for more information.
Fork Best way to use. You will have complete control over the source code.
Docker Another convenient way to use. You will have the control over versions, so it will not break your configuration if you do not update.
Deploy You can deploy from your fork to your server.
Serve You can build your fork and serve locally.

Is It Possible To Edit Files In Docker?

If you want to edit only the configuration, you can simply use config edit command and change anything provided there. You can find instructions on customizing here.

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. With this way, you will be cloning the source code of this project and

  • You will have the control over the source code
  • You can deploy to web
  • Create a docker image
  • Host it locally
  • Pretty much do anything you desire

with your changes on top of my source. Have a look at Fork wiki page for more information.

Clone this wiki locally