Where are the YAML files located?

[mrtargaryen]

I've installed Homepage using Docker Compose. It installed fine and is available on localhost:3000.

I've read some of the documentation that states you have to edit the settings.yml, services.yml, and the widgets.yml.

But as I'm still learning about Docker, so I'm unaware where to find those files.

I'm using Docker in WSL2 on my Windows 11 PC.

Can anyone point me in the right direction?

[sottey]

if you look at your docker compose file OR your docker run command, there should be a volume mapping like this:

/home/username/docker-data/homepage-data:/app/config

The path BEFORE the colon is your computer's path to store the data, the path AFTER is the path inside the docker container.

SO, the answer to your question is that the config files will be in the path to the LEFT of the colon. In this example, /home/username/docker-data/homepage-data

[mrtargaryen]

Great! Thanks.

One last question, are there any example settings.yml, widgets.yml, and services.yml files I can find anywhere? I see in the documentation there appears to be examples on some, but I mean an entire .yml; file that could be used in Homepage.

[sottey]

I can share mine, but I will need to obfuscate them a bit, so it may take me till tomorrow.

[sottey]

Nevermind. It didn't take long at all and it is Friday afternoon so....

Attached are some of the config files.

Caveats:

• These are examples. You will need to change things like IP Addresses, etc. for them to work for you
• You will need to configure your docker API to enable docker info. You will need to learn about that as i don't have the time to teach
• YAML is SUPER picky about indentation, so if something isn't working, check your changes
• The wfun of self hosting is experimentation, so work on issue before asking for help. You'll learn more by doing than having someone tell you what to do.
• Github doesn't allow uploading YAML files, so you will need to rename these from .txt to .yaml to use them

docker.txt
services.txt
settings.txt
widgets.txt

[mrtargaryen]

Thank you so much, I appreciate this. Yes, I was only after these as a guide to learning how to write the .yml files. So thank you very much, these are very useful.

[mrtargaryen]

Nevermind. It didn't take long at all and it is Friday afternoon so....

Attached are some of the config files.

Caveats:

• These are examples. You will need to change things like IP Addresses, etc. for them to work for you
• You will need to configure your docker API to enable docker info. You will need to learn about that as i don't have the time to teach
• YAML is SUPER picky about indentation, so if something isn't working, check your changes
• The wfun of self hosting is experimentation, so work on issue before asking for help. You'll learn more by doing than having someone tell you what to do.
• Github doesn't allow uploading YAML files, so you will need to rename these from .txt to .yaml to use them

docker.txt services.txt settings.txt widgets.txt

- Group A:
    - Service A:
        href: http://localhost/
        description: This is my service
        server: my-server
        container: my-container

For Docker integration, where it says “my-server” what do we put here? Obviously it will be my Docker server, but what exact information goes here, and where do I find it?

[Nionor]

The my-server used in services.yaml should be defined in docker.yaml with the same name.
More information here

[mrtargaryen]

if you look at your docker compose file OR your docker run command, there should be a volume mapping like this:

/home/username/docker-data/homepage-data:/app/config

The path BEFORE the colon is your computer's path to store the data, the path AFTER is the path inside the docker container.

SO, the answer to your question is that the config files will be in the path to the LEFT of the colon. In this example, /home/username/docker-data/homepage-data

The path to the volume I created is: \\wsl.localhost\Ubuntu\docker\volumes\homepage_data\_data
I assume when I create the docker compose, or use docker run, the -v is:

/docker/volumes/homepage_data/_data:/app/config

I've edited the .yaml files into the directory, but nothing is changing after I refresh the page (as indicated in the help documents, bottom right-hand side of Homepage).

Any advice?

I followed the instruction exactly.

Edit:

The place docker has installed Homepage is actualyy here: \\wsl.localhost\Ubuntu\docker-desktop-data\data\docker\volumes\homepage_data\_data

Edit 2:

I edited the .yaml files in \\wsl.localhost\Ubuntu\docker-desktop-data\data\docker\volumes\homepage_data\_data and saved them successfully, and nothing happened when I refreshed Homepage, I even restarted the PC and nothing updated. So I must be doing something wrong.

[Nionor]

Hard to say whats wrong, what changes did you do in what file?
Homepage usually reload the page automatically when I change a file so maybe there is still something wrong with your volumes.

[mrtargaryen]

I got it working after a bit of experimenting. I'm having trouble getting the widgets to display, but I think I'll figure it out. Sorry to sound a bit confused, this is something new for me.

[github-actions[bot]]

This discussion has been automatically closed because it was marked as answered.

[github-actions[bot]]

This discussion has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.