The docs tree is laid out like the menus - a menu path is a docs path.
Admin Panel / Settings follows the new structure: Visibility.md is
Appearance.md, with new Features.md, Feature-Profiles.md, Security.md,
Activities-and-Notifications.md and Delete.md; the section indexes,
Admin-Panel.md, Admin-Panel-URLs.md (with the moved-pane redirects) and
Validation.md follow the live menus, and Who-Sees-What.md explains in one
place which layer decides what is shown and what is allowed.
Pages are added for the menu entries that had none, each written from
the code: every Admin Panel / Problems pane, the member menu, the board
header, Board Settings, the All Boards left menu, and the list,
swimlane and card menus. Older links to the moved panes are updated
across docs/.
TODO.md records what documenting the menus found: Edit Profile does not
save a username for non-admins, the Support page's signed-out case is
unreachable, Create board from this card is hidden from members who can
edit the card, All Boards Settings is unreachable, and the Share template
targets live in browser storage.
Thanks to xet7 !
A feature's guide now sits under the menu it is used from, read from the
templates rather than from where somebody once put it: Header-Bar,
All-Boards, Pages, Board-Header (search and every Board View), Board-Sidebar
(Board Settings, Filter, Members, Labels, Archive), Rules, Swimlanes, Lists,
Cards, Member-Settings, Admin-Panel and Login-Page. Topics used from several
menus (editor, history, theme, translations, email, troubleshooting) are in
General.
- Each area has a README mapping its menu entries to their guides and to the
template or server module that implements them. Board-Header/README.md
lists all 40 Board View entries with the template boardBody.jade renders;
five views (Table, Calendar Mode, Time, Timeline, Map) have no guide of
their own yet and say so.
- Board-View.md listed 25 views while BOARD_VIEWS has 40; it now lists all
of them with their English labels.
- Pages keep their file names. Where a released changelog links an old path,
a "# Moved" page stays there and points to the new one; test-menu.sh skips
folders holding only those.
- Undo was filed under Login; it is General/Undo now.
- Every link in docs, code comments, scripts and tests follows the move;
docsLinksResolve checks them all.
Tests that read a doc follow it to its new place. boardViewSettings now fails
when Board-View.md or Board-Header/README.md differs from BOARD_VIEWS, or
names a template boardBody.jade does not render.
Thanks to xet7 !
Restore editable external image URL fields for the login logo, top-left
corner logo, and board backgrounds, and undo the switch to server-side
download-and-convert-to-GIF storage. Uploading is still available as an
option alongside the URL field for boards; instance and Organization
branding again accept a direct image URL. Imports may again carry
Trello's and WeKan's external background URLs. Tests updated to match.
Move feature and webserver documentation into the reorganized hierarchy, update references to their new relative paths, and extend link validation across the complete documentation tree.\n\nThanks to xet7 !
A design that describes what WeKan already DOES belongs with the feature it
describes, not in the folder for things being proposed. Fifteen docs move:
Design/Accessibility.md -> Features/Accessibility/Accessibility-Improvements.md
Design/Original-Positions.md -> Features/Board/Original-Positions.md
Design/Page/* -> Features/Page/* (thirteen pages that exist)
Design/AdminPanelProblems.md -> Features/Admin-Panel/Problems/Design.md
What stays in docs/Design is what the folder is for: the principles
(Design-Principles, Monkey-Proof-Software), the comparisons, the roadmap
(Multiverse), and the proposals not yet built (Multitenancy, Autoupdate).
The Admin Panel Problems design is new and covers six changes - summaries, the
per-actor tally, IPv4/IPv6 columns, an API report, a per-address login tally,
and blocking with increasing delays. Three are shipped and three are planned;
it is filed under the feature because the pane exists, with each planned item
marked so it can become plain description as it lands.
Every reference in the repository is rewritten - 152 files, including the CSS
comments that point at the table-page design, which a first pass over .md and
.js alone missed. Two suites asserted the old paths and now assert the new
ones. A moved doc whose links nobody fixed is worse than one nobody moved.
Thanks to xet7 !
Implements option D of docs/Design/Multitenancy/Multitenancy.md, which that
document now describes as shipped.
An Organization may claim hostnames (Admin Panel / People / Organizations ->
Edit), carry its own branding - product name, logos, help link, legal notice and
theme colour - and have its own Organization admins, appointed from the row's
"..." menu. The request's host picks the Organization; its branding replaces the
instance branding for that request, and the client bundle that host serves points
its DDP connection back at that host instead of at the one ROOT_URL.
An Organization admin administers their own Organization and nothing else: its
people, its Organizations row, its theme colour and its backups. They can never
grant the site-wide Admin flag, never manage a site admin, and never see another
Organization's people or archives.
Per-tenant backup and restore is one new control in Admin Panel / Attachments /
Backup - Scope. An Organization's archive holds its boards and everything on them
plus the attachments those boards use, and no accounts, no instance settings and
no org/team documents, because those are shared. A restore may only write to
boards that Organization owns: the board ids are the intersection of what the
archive claims with what the Organization really owns, every document is checked
against that, and "replace all" replaces that Organization's documents rather
than everyone's.
Admin Panel / Settings / Visibility gains a Change color section above Logo: the
site theme, rendered by the SAME shared picker as Board Settings and Member
Settings - one template for all three, the way one shared table page serves every
table. Its design is the new docs/Design/Page/Theme.md. The order of themes is
WeKan's default theme, then the site theme (an Organization's own value on its own
hosts), then a user's own override; a board's own colour still owns the board page.
All of it is OFF unless the server is started with MULTITENANCY=true (plus
MULTITENANCY_TRUST_PROXY_HOST=true when a trusted proxy sets X-Forwarded-Host), so
an instance that has never heard of tenants answers exactly as before. One WeKan
server per customer remains the supported topology for customers who must not
share a process, and the design says plainly what this does NOT isolate.
The decisions are three pure modules - models/lib/tenants.js, tenantAdmin.js and
tenantBackup.js - so the same rules run on the client, on the server and in the
tests. Four new suites pin the separation rather than the plumbing: forged Host
headers, cross-tenant queries, privilege escalation and cross-tenant restores.
Thanks to xet7 !
One MongoDB server holding one database per tenant - which is the shipped
docker-compose-multitenancy.yml unchanged. Only the Node side differs from the
baseline: one process opens all of those databases instead of n processes opening
one each. And because each driver takes a full connection URL, one server with
many databases is the common case rather than a requirement - a large tenant can
be moved to its own mongod without the others noticing.
Thanks to xet7 !
docs/Design/Multitenancy/Multitenancy.md. The shipped topology
(docs/Platforms/FOSS/Docker/Meteor3/) runs one WeKan Node.js server per customer:
one ROOT_URL, one database, one uws.port and one upgrade each. This designs the
alternatives to that - one server serving many domains - and says what each one
would cost, from WeKan's own code rather than in the abstract.
Six things one process must solve, with the Meteor 3 API for each: resolving the
tenant from the Host header (Meteor.onConnection gives httpHeaders, cookies
excluded; behind a proxy it is X-Forwarded-Host, and a forgeable header is a data
leak); the client bundle's baked-in ROOT_URL (WebApp.addRuntimeConfigHook rewrites
__meteor_runtime_config__ per request - and was broken in Meteor 3.0 alpha/beta/rc
until meteor#13156, which any use of it has to state a minimum version for);
server-side absolute URLs (Meteor.absoluteUrl's {rootUrl} override, and the handful
of WeKan call sites - universalUrlGenerator.js already builds relative URLs and is
the model); the data itself; accounts; and the eight settings singletons plus the
~102 process.env reads that are per-process today.
Four alternatives, compared in a table: one process per tenant (today), one
database with a tenant field (mizzao:partitioner from Meteor-Community-Packages,
Meteor 3 async), a database per tenant in one process (MongoInternals.
RemoteCollectionDriver), and Organizations as tenants - which is the one WeKan
already half has, since orgs, teams, their membership and the same-Organization /
same-Team board restriction all exist and are enforced server-side.
The recommendation is to keep one process per tenant as the supported topology and
reach for Organizations when the tenants are groups of one organisation: the other
two trade an operational cost that is merely tedious for a failure mode - a missed
selector on one of 46 collections or 66 publications - that is silent
cross-tenant disclosure. With, if it is ever attempted, the order that keeps it
honest: resolve the tenant once, do the settings singletons first because they
prove the pattern end to end, content collections only then with a test per
publication, and accounts last or not at all.
Linked from the two guides it is about and from the Scaling section of
docs/README.md.
Thanks to xet7 !