mirror of
https://github.com/jcreek/OpenNetworkDiagram.git
synced 2026-07-12 18:43:44 +00:00
feat(#5): add local vendored icon catalog manifest and attribution
This commit is contained in:
Josh Creek
@@ -17,6 +17,7 @@
|
||||
✅ **Interactive network visualisation**
|
||||
✅ **Single-page modal editor with live updates**
|
||||
✅ **Debounced autosave to JSON (self-hosted)**
|
||||
✅ **Local vendored icon catalog (offline runtime)**
|
||||
✅ **Lightweight Svelte**
|
||||
|
||||
Use it to **document your home lab, office network, or cloud infrastructure** with an easy-to-use web interface.
|
||||
@@ -96,6 +97,7 @@ pnpm run dev
|
||||
pnpm run build # default (Docker/static target)
|
||||
pnpm run build:docker # explicit Docker/static target
|
||||
pnpm run build:netlify # Netlify target (read-only mode)
|
||||
pnpm run icons:manifest # regenerate local vendor icon manifest
|
||||
```
|
||||
|
||||
---
|
||||
@@ -105,8 +107,11 @@ pnpm run build:netlify # Netlify target (read-only mode)
|
||||
```text
|
||||
open-network-diagram/
|
||||
├── src/ # Svelte app source
|
||||
├── src/lib/config/vendorIconManifest.ts # Generated local icon catalog
|
||||
├── static/data/network.json # Demo dataset (Netlify/demo)
|
||||
├── static/icons/vendor/ # Vendored icon assets (runtime-local)
|
||||
├── data/network.json.example # User data template (Docker)
|
||||
├── third_party/ # Third-party license/provenance notes
|
||||
├── Dockerfile # Docker build/runtime
|
||||
├── server.mjs # Node runtime server (static + /api/network-data)
|
||||
├── docker-compose.yml # Local Docker run with mounted data
|
||||
@@ -144,6 +149,16 @@ docker run --rm -p 8080:3000 \
|
||||
- **`NETWORK_BACKUP_DIR`** (default: sibling `.backups`)
|
||||
Backup directory for rolling save backups (last 5 retained).
|
||||
|
||||
### **Local Icon Catalog (No Runtime Network Dependency)**
|
||||
|
||||
- Icons are vendored locally under **`static/icons/vendor/homarr/`**.
|
||||
- The searchable catalog is generated into **`src/lib/config/vendorIconManifest.ts`**.
|
||||
- Third-party provenance and licensing are documented in:
|
||||
- **`third_party/homarr-dashboard-icons/SOURCE.txt`**
|
||||
- **`third_party/homarr-dashboard-icons/LICENSE`**
|
||||
- **`third_party/homarr-dashboard-icons/NOTICE.txt`**
|
||||
- Runtime icon search/rendering does not call external APIs.
|
||||
|
||||
### **CI/CD (GitHub Actions + Netlify)**
|
||||
|
||||
- GitHub Actions workflow (`.github/workflows/docker.yml`) builds Docker on PRs.
|
||||
|
||||
@@ -13,6 +13,7 @@
|
||||
"prepare": "svelte-kit sync || echo ''",
|
||||
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
|
||||
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
|
||||
"icons:manifest": "node scripts/generate-vendor-icon-manifest.mjs",
|
||||
"format": "prettier --write .",
|
||||
"lint": "prettier --check . && eslint ."
|
||||
},
|
||||
|
||||
@@ -0,0 +1,162 @@
|
||||
import { promises as fs } from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
|
||||
const currentFilePath = fileURLToPath(import.meta.url);
|
||||
const currentDirPath = path.dirname(currentFilePath);
|
||||
const projectRoot = path.resolve(currentDirPath, '..');
|
||||
|
||||
const vendorRoot = path.join(projectRoot, 'static/icons/vendor/homarr');
|
||||
const outputPath = path.join(projectRoot, 'src/lib/config/vendorIconManifest.ts');
|
||||
|
||||
const allowedExtensions = new Set(['.svg', '.png', '.webp']);
|
||||
const extensionPriority = {
|
||||
'.svg': 0,
|
||||
'.png': 1,
|
||||
'.webp': 2
|
||||
};
|
||||
|
||||
/** @param {string} input */
|
||||
function toPosixPath(input) {
|
||||
return input.split(path.sep).join('/');
|
||||
}
|
||||
|
||||
/** @param {string} filename */
|
||||
function toSlug(filename) {
|
||||
return filename
|
||||
.toLowerCase()
|
||||
.replace(/[^a-z0-9._-]/g, '-')
|
||||
.replace(/[._]+/g, '-')
|
||||
.replace(/-+/g, '-')
|
||||
.replace(/^-|-$/g, '');
|
||||
}
|
||||
|
||||
/** @param {string} slug */
|
||||
function toLabel(slug) {
|
||||
return slug
|
||||
.split('-')
|
||||
.filter(Boolean)
|
||||
.map((part) => part.charAt(0).toUpperCase() + part.slice(1))
|
||||
.join(' ');
|
||||
}
|
||||
|
||||
/** @param {string} dir */
|
||||
async function walk(dir) {
|
||||
const entries = await fs.readdir(dir, { withFileTypes: true });
|
||||
const files = entries
|
||||
.filter((entry) => entry.isFile())
|
||||
.map((entry) => path.join(dir, entry.name));
|
||||
const directories = entries
|
||||
.filter((entry) => entry.isDirectory())
|
||||
.map((entry) => path.join(dir, entry.name));
|
||||
const nestedFileLists = await Promise.all(directories.map((childDirectory) => walk(childDirectory)));
|
||||
|
||||
for (const nestedFiles of nestedFileLists) {
|
||||
files.push(...nestedFiles);
|
||||
}
|
||||
return files;
|
||||
}
|
||||
|
||||
function compareIconRecords(a, b) {
|
||||
const labelCompare = a.label.localeCompare(b.label);
|
||||
if (labelCompare !== 0) {
|
||||
return labelCompare;
|
||||
}
|
||||
return a.key.localeCompare(b.key);
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const vendorExists = await fs
|
||||
.access(vendorRoot)
|
||||
.then(() => true)
|
||||
.catch(() => false);
|
||||
|
||||
if (!vendorExists) {
|
||||
throw new Error(`Vendor icon directory not found: ${vendorRoot}`);
|
||||
}
|
||||
|
||||
const allFiles = await walk(vendorRoot);
|
||||
const dedupedBySlug = new Map();
|
||||
|
||||
for (const absoluteFilePath of allFiles) {
|
||||
const extension = path.extname(absoluteFilePath).toLowerCase();
|
||||
if (!allowedExtensions.has(extension)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const relativePath = toPosixPath(path.relative(vendorRoot, absoluteFilePath));
|
||||
const basename = path.basename(relativePath, extension);
|
||||
const slug = toSlug(basename);
|
||||
if (!slug) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const key = `homarr:${slug}`;
|
||||
const candidate = {
|
||||
key,
|
||||
label: toLabel(slug),
|
||||
path: `/icons/vendor/homarr/${relativePath}`,
|
||||
source: 'homarr-dashboard-icons',
|
||||
extension,
|
||||
priority: extensionPriority[extension] ?? 99,
|
||||
relativePath
|
||||
};
|
||||
|
||||
const existing = dedupedBySlug.get(slug);
|
||||
if (!existing) {
|
||||
dedupedBySlug.set(slug, candidate);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (candidate.priority < existing.priority) {
|
||||
dedupedBySlug.set(slug, candidate);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (candidate.priority === existing.priority && candidate.relativePath < existing.relativePath) {
|
||||
dedupedBySlug.set(slug, candidate);
|
||||
}
|
||||
}
|
||||
|
||||
const records = Array.from(dedupedBySlug.values())
|
||||
.sort(compareIconRecords)
|
||||
.map(({ key, label, path: iconPath, source }) => ({ key, label, path: iconPath, source }));
|
||||
|
||||
const header = [
|
||||
'/* eslint-disable */',
|
||||
'// prettier-ignore',
|
||||
'// Auto-generated by scripts/generate-vendor-icon-manifest.mjs',
|
||||
'// Do not edit manually.',
|
||||
'',
|
||||
'export interface VendorIconDefinition {',
|
||||
' key: string;',
|
||||
' label: string;',
|
||||
' path: string;',
|
||||
" source: 'homarr-dashboard-icons';",
|
||||
'}',
|
||||
'',
|
||||
'export const VENDOR_ICON_DEFINITIONS: VendorIconDefinition[] = ['
|
||||
].join('\n');
|
||||
|
||||
const body = records
|
||||
.map((record) => {
|
||||
const key = JSON.stringify(record.key);
|
||||
const label = JSON.stringify(record.label);
|
||||
const iconPath = JSON.stringify(record.path);
|
||||
return ` { key: ${key}, label: ${label}, path: ${iconPath}, source: 'homarr-dashboard-icons' },`;
|
||||
})
|
||||
.join('\n');
|
||||
|
||||
const footer = ['];', ''].join('\n');
|
||||
const output = `${header}\n${body}\n${footer}`;
|
||||
|
||||
await fs.mkdir(path.dirname(outputPath), { recursive: true });
|
||||
await fs.writeFile(outputPath, output, 'utf8');
|
||||
|
||||
}
|
||||
|
||||
main().catch((error) => {
|
||||
const message = error instanceof Error ? error.stack ?? error.message : String(error);
|
||||
process.stderr.write(`${message}\n`);
|
||||
process.exitCode = 1;
|
||||
});
|
||||
@@ -0,0 +1,17 @@
|
||||
# Vendor Icon Refresh
|
||||
|
||||
This project vendors icon assets from `homarr-labs/dashboard-icons` into:
|
||||
|
||||
- `static/icons/vendor/homarr/`
|
||||
|
||||
After refreshing the vendored files, regenerate the searchable manifest:
|
||||
|
||||
```bash
|
||||
pnpm run icons:manifest
|
||||
```
|
||||
|
||||
Then verify:
|
||||
|
||||
- `src/lib/config/vendorIconManifest.ts` changed as expected
|
||||
- `third_party/homarr-dashboard-icons/SOURCE.txt` has the new upstream commit/date
|
||||
- `third_party/homarr-dashboard-icons/LICENSE` still matches upstream
|
||||
@@ -1,18 +1,23 @@
|
||||
import { VENDOR_ICON_DEFINITIONS } from './vendorIconManifest';
|
||||
|
||||
export interface IconDefinition {
|
||||
key: string;
|
||||
label: string;
|
||||
path: string;
|
||||
source?: 'built-in' | 'homarr-dashboard-icons';
|
||||
}
|
||||
|
||||
const ICONS: IconDefinition[] = [
|
||||
{ key: 'server', label: 'Server', path: '/icons/server.svg' },
|
||||
{ key: 'router', label: 'Router', path: '/icons/router.svg' },
|
||||
{ key: 'switch', label: 'Switch', path: '/icons/switch.svg' },
|
||||
{ key: 'storage', label: 'Storage', path: '/icons/storage.svg' },
|
||||
{ key: 'desktop', label: 'Desktop', path: '/icons/desktop.svg' },
|
||||
{ key: 'cloud', label: 'Cloud', path: '/icons/cloud.svg' }
|
||||
const BUILTIN_ICONS: IconDefinition[] = [
|
||||
{ key: 'server', label: 'Server', path: '/icons/server.svg', source: 'built-in' },
|
||||
{ key: 'router', label: 'Router', path: '/icons/router.svg', source: 'built-in' },
|
||||
{ key: 'switch', label: 'Switch', path: '/icons/switch.svg', source: 'built-in' },
|
||||
{ key: 'storage', label: 'Storage', path: '/icons/storage.svg', source: 'built-in' },
|
||||
{ key: 'desktop', label: 'Desktop', path: '/icons/desktop.svg', source: 'built-in' },
|
||||
{ key: 'cloud', label: 'Cloud', path: '/icons/cloud.svg', source: 'built-in' }
|
||||
];
|
||||
|
||||
const ICONS: IconDefinition[] = [...BUILTIN_ICONS, ...VENDOR_ICON_DEFINITIONS];
|
||||
|
||||
const ICON_BY_KEY = new Map(ICONS.map((icon) => [icon.key, icon]));
|
||||
|
||||
export function listIconDefinitions(): IconDefinition[] {
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
+201
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright (c) 2024 Bjorn Lammers, Meier Lukas, Thomas Camlong and Homarr Labs
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -0,0 +1,3 @@
|
||||
This project vendors icon assets from homarr-labs/dashboard-icons.
|
||||
These assets are included locally to avoid runtime dependency on external icon sources.
|
||||
See SOURCE.txt for upstream commit details and LICENSE for license terms.
|
||||
@@ -0,0 +1,7 @@
|
||||
Upstream repository: https://github.com/homarr-labs/dashboard-icons
|
||||
Upstream commit: b44b1bc165d9e7203097dde5d174190e80b6e9ae
|
||||
Upstream commit date (UTC): 2026-02-25T10:27:35Z
|
||||
Imported on: 2026-02-25
|
||||
License: Apache-2.0
|
||||
Notes: Icons are vendored locally for offline/runtime independence.
|
||||
Trademark notice: Product names, logos, and trademarks remain property of their respective owners.
|
||||
Reference in New Issue
Block a user