Roland/Assetmanager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

repo descriptions updated

Browse Source
This commit is contained in:
Roland
2026-08-08 10:36:34 +00:00
parent daeb08c054
commit 2786f12ab6
13 changed files with 94 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+52 -59
View File
@@ -1,38 +1,39 @@
# AssetManager 0.5.5.41
# AssetManager 0.5.5.42
AssetManager is a self-hosted web application for managing IT equipment and other organizational assets. The project is released under the **Apache License 2.0** and may be used, modified, and redistributed for private and commercial purposes.
AssetManager is a self-hosted web application for managing IT equipment and other organizational assets. It provides asset inventory, software inventory, remote job execution, reporting, privacy/retention documentation, and optional integration with MeshCentral.
The project is licensed under the **Apache License 2.0** and may be used, modified, and redistributed for private and commercial purposes under the terms of that license.
## Features
- configurable asset categories, fields, and status values
- asset lists, detail views, history, assignment, and return workflows
- Excel import and export, bulk changes, duplicate merging, and tree views
- hardware and software inventory
- job definitions and job execution with status tracking, callbacks, retries, and logs
- local user management and optional LDAP authentication
- protected local emergency administrator even when LDAP is enabled
- roles, visibility rules, translations, dark mode, and configurable appearance
- integrated backup and restore functions
- configurable asset categories, fields, status values, images, and assignments
- asset lists, detail views, history, bulk editing, Excel import/export, duplicate merging, and tree views
- hardware and software inventory with comparison and aggregation views
- job definitions and remote job execution with status tracking, callbacks, retries, and logs
- optional MeshCentral integration through the MeshCtrl command-line interface
## MeshCentral integration
The integration is optional. AssetManager uses MeshCtrl for supported device queries and remote jobs. It does not access the MeshCentral database directly. MeshCentral and MeshCtrl are independent third-party projects and are not part of this repository; they are installed as dependencies during the Docker build.
- local users, optional LDAP/Active Directory authentication, and a protected local emergency administrator
- roles and asset visibility rules
- multilingual user interface, dark mode, charts, and configurable appearance
- integrated application backup and restore
- privacy and retention documentation with text, HTML, and Excel exports
## Requirements
- Docker Engine with Docker Compose
- a suitable DNS name and HTTPS reverse proxy are recommended for production installations
- optionally, a reachable MeshCentral instance
- optionally, LDAP or Active Directory
- a supported PostgreSQL container as defined by `docker-compose.yml`
- a suitable DNS name and HTTPS reverse proxy are recommended for production use
- optional: reachable MeshCentral instance
- optional: LDAP or Active Directory
## Installation
Create the local environment file:
```bash
cp .env.example .env
```
Set at least these values in `.env`:
Set at least the required secrets in `.env`:
```env
POSTGRES_PASSWORD=CHANGE_ME
@@ -41,13 +42,13 @@ LOCAL_ADMIN_USERNAME=emergency-admin
LOCAL_ADMIN_PASSWORD=CHANGE_ME_MIN_12_CHARS
```
Then start the application:
Start the application:
```bash
docker compose up -d --build
```
By default, the application is available on port `8088`.
By default, AssetManager is exposed on port `8088`.
## Persistent data
@@ -63,11 +64,29 @@ data/
└── scripts/ deployed scripts
```
These directories and `.env` may contain credentials, personal data, or internal operational data and must not be committed to a public repository.
These directories and `.env` may contain credentials, personal data, or internal operational information and must not be committed to a public repository.
## Authentication
AssetManager supports local authentication and LDAP/Active Directory authentication. A protected local emergency administrator can be configured through environment variables so that administrative access remains possible if LDAP is unavailable.
LDAP debug logging is optional and should normally remain disabled. When disabled, LDAP logs contain only reduced authentication information.
## MeshCentral integration
MeshCentral integration is optional. AssetManager uses MeshCtrl for supported device queries, synchronization, presence information, file transfer, and remote jobs. AssetManager does not access the MeshCentral database directly.
MeshCentral and MeshCtrl are independent third-party projects and are not part of this repository. They are installed as dependencies during the Docker build.
## Privacy and retention
The application includes a **Security & Privacy** section for documenting processing activities, data categories, retention periods, recipients, international transfers, technical and organizational measures, and deletion checks. Reports can be exported as text, HTML, or Excel.
Deletion functions are restricted to administrators. Exported reports do not include passwords, callback tokens, or other secrets.
## Updating
Always back up `.env` and the complete `data/` directory before updating. Copy the new `assetmanager/` directory over the existing project directory and run:
Back up `.env` and the complete `data/` directory before updating. Copy the new `assetmanager/` directory over the existing project directory and rebuild the application container:
```bash
docker compose down
@@ -75,45 +94,19 @@ docker compose up -d --build
docker compose logs --tail=100 -f
```
Detailed release notes are stored in [`docs/version-history/`](docs/version-history/README.md).
## Creating a sanitized public source archive
The exporter creates a sanitized ZIP archive with exactly one top-level directory named `assetmanager/`:
```bash
python tools/create_github_source.py
```
Before exporting, the script validates versions, license metadata, sensitive runtime files, and unwanted product-comparison references.
## Validation
```bash
python tools/check_public_release.py
python tools/check_translations.py
python tools/validate_release.py
```
## Documentation
- [Client communication and software deployment architecture](docs/architecture/SOFTWARE-CLIENT-ARCHITECTURE.md)
- [Version history](docs/version-history/README.md)
- [Contributing](CONTRIBUTING.md)
- [Security policy](SECURITY.md)
- [Third-party notices](THIRD_PARTY_NOTICES.md)
## Third-party components
Direct dependencies and their license types are listed in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). During the Docker build, license files from the installed Python and Node.js packages are collected under `/app/THIRD_PARTY_LICENSES/`.
## Contributing
Contributions and forks are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md). A submission is a proposal and does not create an obligation to include it in the official project.
Historical release notes are available in [`docs/version-history/`](docs/version-history/README.md).
## Security
Do not disclose credentials or exploitable details in a public issue. See [SECURITY.md](SECURITY.md).
Do not commit credentials, tokens, private keys, personal data, runtime databases, logs, backups, or internal deployment details. Security reporting guidance is available in [SECURITY.md](SECURITY.md).
## Third-party components
Direct dependencies and license information are listed in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). During the Docker build, license files from installed Python and Node.js packages are collected under `/app/THIRD_PARTY_LICENSES/`.
## Contributing
Contributions and bug reports are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for repository contribution requirements.
## License