guillm/portulan
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed missing field from example config in README
Some checks failed
Build and deploy all / build (amiral.json, /var/www/amiral, amiral) (push) Failing after 8m17s
Details
Build and deploy all / build (atlantis.json, /var/www/atlantis, atlantis) (push) Failing after 43s
Details
Build and deploy all / build (harbor.json, /var/www/harbor, harbor) (push) Failing after 41s
Details
Build and deploy all / deploy (amiral.json, /var/www/amiral, amiral) (push) Has been skipped
Details
Build and deploy all / deploy (atlantis.json, /var/www/atlantis, atlantis) (push) Has been skipped
Details
Build and deploy all / deploy (harbor.json, /var/www/harbor, harbor) (push) Has been skipped
Details
Build and deploy all / notify (push) Successful in 2s
Details

Browse source
This commit is contained in:
Gu://em_ 2026-04-07 17:50:51 +02:00
parent d5b638405f
commit b70ccb58b7
2 changed files with 13 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,18 +1,21 @@
# Oblic Parallels Home Website
# Portulan
## About
Contains the source code of the Home OP website.
Now uses Astro instead of the old static website !
Portulan is a project that lets you generate a website to showcase all of your services. It was originally created for homelabs but you may use it any way you can think of.
It's actually the source code for all the Oblic Parallels portals.
## How to use it
### Configuration
If you want to use this project for yourself, you'll first want to edit the configuration file located at `src/data/content.json`.
The file should look like this, don't hesitate to take the provided template file to make yours.
```json
{
"website_title": "Website Title",
"website_logo": "https://...",
"page_name": "",
"website_status_link": "https://...",
"colors": {
... // Optional
@ -40,7 +43,7 @@ The file should look like this, don't hesitate to take the provided template fil
> "icon": "../assets/some-icon.svg",
>```
### Optimized image loading
#### Optimized image loading
I would recommend to use only SVGs in your image links if possible. If it's not possible and that you want to optimize the loading time, you should use the lazy image loading.
> [!WARNING]
> This feature is not implemented yet and you'll have to go manually inside the `src/components/` folder to make modifications.
@ -74,6 +77,11 @@ const { title, icon, ... } = Astro.props;
```
Note that in this case, it would be a good idea to store your images in the assets folder an to access them using their relative path to let astro generate what it needs to fully take advantage of this feature.
### Automatic deployment
There is a CI/CD pipeline in `.forgejo/workflows/deploy.yaml` that lets you automatically build and deploy the website. It's actually configured to do so with Oblic Parallels but you can easily use it to do the same thing on your own server.
As it takes time I don't really want to document it right now but if you're interested, feel free to contact me or to open an issue and I will probably do it.
## Structure
### Project