How To Customize

Customization

There are basically 2 ways of customizing this project

• From your source code (fork)
• From built-in config tool (on-the-fly)

From The App

Depending on how you use, the commands below will store your configuration differently.

Online Version

This will always store your configuration on your browsers local storage. If you are using multiple browsers, you can copy-paste the configuration from the editor into other browsers. Even better, you can create a public repository for this config file so you can import it anytime from anywhere.

Docker (Volume)

Using Docker Compose with volume for configurations will always store your data within a docker volume. Your data will persist as long as you do not erase that volume from your disk.

Docker (Mount)

If you have mounted a directory from your user folder, the data will be updated in that directory and will persist there as long as you do not erase that directory from your disk.

Built-In Config Tool

You can use the built-in editor for customizing on the fly.

1. Use config edit command to launch editor
2. When you complete editing, hit SAVE button located on the bottom right of the window
3. If you see Incorrect JSON error, please check your JSON for errors

Import Remote Config

If you already have stored your configuration on a remote, you can import your remote configuration by using config import <url>.

Example:

config import https://raw.githubusercontent.com/excalith/.dotfiles/main/config/startpage/excalith-start-page.json

From Docker Mount

Warning

This applies only for Docker Bind Mount setup.

If you used a bind mount while composing up, you will realize that you only have the required settings.json file in your data folder. This is intended as it provides you with the only file required to run the app. However, you can add / remove assets and change settings from your mount.

If you want to add something to your data folder, please consider using this convention

• Custom assets should be in assets folder
• Custom themes should be in themes folder

Then you can change both theme and urls of fetch icon and wallpaper url using config edit

Tip

You should be able to mount your configuration from your dotfiles repository as well.

From Source Code

If you forked the project, you can change the settings.json file located in the data folder.

If you want to add something to that data folder, please consider using this convention

• Custom themes should be in themes folder
• Custom assets should be in assets folder

This will help you build your start page with your own settings and assets.