Skip to content

Use

Modules

Turn modules on for an installation, grant them person by person, and how access levels combine.

Knotworking is a platform plus modules. The platform is always on: sign-in, workspaces, members, teams, API tokens, attachments, notifications and search. Everything else is a module, switched on for the installation and then granted person by person.

Turning modules on

KNOTWORKING_MODULES lists the modules this installation runs. The API and the MCP server read the same variable.

deploy/.env
KNOTWORKING_MODULES=tasks,docs,time          # just these
# KNOTWORKING_MODULES=all                    # every module, flagged ones included
# KNOTWORKING_MODULES=none                   # the platform alone
  • Unset means every module except the flagged ones: calendar sync, accounting and dashboards are opt-in.
  • An unknown id, or a module without one it depends on (time without tasks), stops the API at startup, so a typo can't quietly switch something off.
  • Switching a module off hides its pages, data and tools. Nothing is deleted, and switching it back on restores everything, including who had access.

Access levels

In Settings, Members, Module access, an admin gives each person a level on each active module.

LevelMeans
noneThe module doesn't exist for this person.
readThey can look, not change.
writeEverything the module's ordinary pages offer.
manageThe module's privileged actions, such as approvals and stock adjustments.

Access rules

  • Owners and admins always have manage on every active module.
  • Everyone else gets their explicit grant, or the module's default: tasks, docs, time, calendar and dashboards follow the role (members write, guests read); the rest are off until granted.
  • Guests never get more than read.
  • A module is off for a person when a module it depends on is off for them.
  • An API token has its owner's access, optionally narrowed to a list of modules. It can never widen it.

All modules

Work

ModuleIdDepends on
Tasks and projectstasksNone
DocumentsdocsNone
Time trackingtimeTasks and projects
Calendar and meetingsflaggedcalendarNone
DashboardsflaggedbiNone
AssistantassistantNone

People

ModuleIdDepends on
PeoplepeopleNone
TrainingtrainingPeople
AttendanceattendancePeople
Workforce planningworkforcePeople
Private HR recordsworkforce_hrWorkforce planning

Operations

ModuleIdDepends on
Items and suppliersitemsNone
RecipesrecipesItems and suppliers
SOPssopsNone
StockstockItems and suppliers
Demand planningdemandItems and suppliers
ProductionproductionRecipes, Stock, Demand planning
Food safety recordshaccpItems and suppliers, Production
QualityqualityItems and suppliers, Stock
PurchasingpurchasingItems and suppliers, Stock
CostingcostingRecipes, Production, Purchasing
Site programmessiteFood safety records
Labels and nutritionlabelsRecipes
SpecificationsspecificationsItems and suppliers
TestingtestingItems and suppliers, Stock
Product developmentnpdItems and suppliers, Recipes
Food defencedefenceNone
Management reviewgovernanceNone
Health, safety and environmenthseSite programmes, Training
HSE incidentshse_incidentsHealth, safety and environment

Sales and finance

ModuleIdDepends on
CustomerscustomersNone
SalessalesCustomers, Items and suppliers
DespatchdespatchCustomers, Stock
Accounting integrationsflaggedaccountingNone