Skip to content

Data Model

Users

ColumnTypeDescription
idTEXT (UUID)Primary key
usernameTEXTUnique username
passwordTEXTbcrypt hash
modeTEXTsticky or random
statusTEXTactive or disabled
created_atTEXTISO 8601 timestamp
updated_atTEXTISO 8601 timestamp

Subnets

ColumnTypeDescription
idTEXT (UUID)Primary key
cidrTEXTUnique CIDR notation (e.g., 2001:db8:1::/64)
gatewayTEXTGateway address (optional)
statusTEXTactive or disabled
created_atTEXTISO 8601 timestamp

Sticky Bindings

ColumnTypeDescription
idTEXT (UUID)Primary key
user_idTEXTReferences users(id)
subnet_idTEXTReferences subnets(id)
ipv6_addrTEXTAllocated IPv6 address (full expanded form)
bound_atTEXTISO 8601 timestamp

Traffic Stats

ColumnTypeDescription
idTEXT (UUID)Primary key
user_idTEXTReferences users(id)
dateTEXTDate in YYYY-MM-DD format
bytes_inINTEGERBytes received from target
bytes_outINTEGERBytes sent to target

Audit Logs

ColumnTypeDescription
idTEXT (UUID)Primary key
user_idTEXTReferences users(id), nullable
actorTEXTWho performed the action (system or username)
actionTEXTAction identifier
detailTEXTJSON string with action details
created_atTEXTISO 8601 timestamp

Rate Limits

ColumnTypeDescription
idTEXT (UUID)Primary key
user_idTEXTUnique, references users(id)
max_connectionsINTEGERMax concurrent connections (nullable)
max_bandwidthINTEGERMax bytes/sec (nullable)

Released under the MIT License.