README
¶
NimoOS-Common
About
NimoOS is a fork of CasaOS (Apache-2.0), originally developed by IceWhale Technology Co., Ltd. Building on that foundation, NimoOS adds an AI agent, RAG-based retrieval, a knowledge layer, and a built-in web terminal.
See
NOTICEfor attribution details. CasaOS and IceWhale are trademarks of IceWhale Technology Co., Ltd. NimoOS is an independent project and is not affiliated with, endorsed by, or sponsored by IceWhale Technology Co., Ltd.
⚠️ Multi-user isolation is incomplete — Photos and Search are not yet per-user scoped. Read SECURITY.md before deploying NimoOS for more than one person.
Common structs and functions for NimoOS
Documentation
See OVERVIEW.md for architecture details.
License
Documentation
¶
Overview ¶
TODO: the original openapi.yaml came from NimoTech/IceWhale-OpenAPI (no longer accessible); commented out for now, using the already-generated codegen/mod_management/api.go //go:generate bash -c "mkdir -p codegen/mod_management && go run github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@v2.1.0 -generate types,client -package mod_management https://raw.githubusercontent.com/NimoTech/IceWhale-OpenAPI/refs/heads/main/zimaos-mod-management/mod_management/openapi.yaml > codegen/mod_management/api.go"
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MigrationTool ¶
type MigrationTool interface {
IsMigrationNeeded() (bool, error)
PreMigrate() error
Migrate() error
PostMigrate() error
}
Any logic to migrate data from previous version to current can implement this interface.
The model for migrating from v0.n to v0.m is an execution chain of each version of this migration tool:
START -> migration-tool-v0.n -> migration-tool-v0.n+1 -> ... -> migration-tool-v0.m -> END
Therefore, each migration tool in the chain SHOULD ONLY work on data such as config files and databases. It is responsibility of any install/setup script to control the services because it knows when migration starts and ends.
!!!IMPORTANT!!! DO NOT stop, start, enable or disable services, because the whole execution chain might not have been completed.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
codegen
|
|
|
mod_management
Package mod_management provides primitives to interact with the openapi HTTP API.
|
Package mod_management provides primitives to interact with the openapi HTTP API. |
|
The commmon package provides structs and functions for external code to interact with this gateway service.
|
The commmon package provides structs and functions for external code to interact with this gateway service. |
|
notify
@Author: LinkLeong link@icewhale.com
|
@Author: LinkLeong link@icewhale.com |
|
pkg
|
|
|
Package upload is the common kernel for the resumable upload engine: model, state machine, tiered GC, and Store interface.
|
Package upload is the common kernel for the resumable upload engine: model, state machine, tiered GC, and Store interface. |
|
http
methods in this package automatically include a context with a timeout, in order to solve the problem of hanging requests and to avoid goroutine leaks
|
methods in this package automatically include a context with a timeout, in order to solve the problem of hanging requests and to avoid goroutine leaks |