π Documentation
Welcome to Restore Canvassing
A complete guide to every feature of the Restore Canvassing political canvassing platform β organised by role.
π₯ Choose Your Role
Restore Canvassing has four roles, each with a different level of access. Select yours below to jump straight to what's relevant.
πΆ
Canvasser
Door-to-door canvassers. Find addresses, record visits, log residents, follow routes, earn badges, and read policy articles.
πΏ
Branch Manager
Full branch control. Manage users, create routes, monitor live canvassers on a map, approve tag suggestions, and access all reports.
π€
Branch Assistant
Operational support. Can canvass, manage routes and literature, view live map, manage local parties and tags, and access all reports β but cannot manage users.
βοΈ
Administrator
Full system access. Manages all branches, parties, national tags, support levels, policy content, and every national report and audit trail.
π Signing In
All users log in through the same screen. Your role is determined server-side β you don't select it at login.
1
Enter your email and password
Your account is created by an admin or branch manager. You set your own password either via an invitation email or after a manager creates the account and shares the temporary credentials.
2
Two-factor authentication (if enabled)
If you've set up TOTP two-factor authentication in your profile, you'll be prompted for your 6-digit authenticator code after your password.
3
Redirected to your home screen
Canvassers land on the address search and nearby screen. Branch managers, assistants, and admins land on the management dashboard β use Go Canvassing from the dashboard to access the canvasser interface.
βΉοΈ
Forgotten your password? Contact your branch manager or admin β they can reset it from the Users panel and share new credentials.
π‘οΈ Permissions at a Glance
A quick-reference table showing which features are available to each role.
| Feature |
Canvasser |
Asst. |
Manager |
Admin |
| Canvass addresses & record visits | β | β | β | β |
| Add / edit / delete residents | β | β | β | β |
| Follow routes & areas | β | β | β | β |
| Badges, leaderboard & activity log | β | β | β | β |
| Share live GPS location | β | β | β | β |
| Suggest issue tags | β | β | β | β |
| Policy articles (read & favourite) | β | β | β | β |
| Create & manage routes | β | β | β | β |
| Manage branch literature | β | β | β | β |
| View branch reports | β | β | β | β |
| Live map (canvassers on map) | β | β | β | β |
| Manage local parties | β | β | β | β |
| Manage local issue tags | β | β | β | β |
| Write policy articles | β | β | β | β |
| Approve / reject suggested tags | β | View | β | β |
| Invite & manage users | β | β | β | β |
| Edit branch settings | β | β | β | β |
| Manage all branches | β | β | β | β |
| Import addresses (OS Places) | β | β | β | β |
| Manage national issue tags | β | β | β | β |
| Manage parties & support levels | β | β | β | β |
| National policy articles | β | β | β | β |
| Constituency overlay on live map | β | β | β | β |
| Audit log | β | β | β | β |
π€ Your Profile
Every user can manage their own profile. Tap your avatar or name in the top-right corner to open profile settings.
πΌοΈ
Profile Photo
Upload an avatar which appears on the leaderboard and live-map beacons.
βοΈ
Name & Email
Update your display name and login email at any time.
π
Live Location Sharing
Opt in to share your GPS position while canvassing. Visible to branch managers and admins on the live map while a route is active.
π
Home Postcode
Set your home postcode to activate a 200-metre privacy radius. When within 200m of home, your exact GPS position is withheld β only an approximate nearby location is transmitted.
π
Change Password
Enter your current password then choose a new one meeting the strength requirements.
π
Two-Factor Auth
Set up TOTP 2FA with any authenticator app (Google Authenticator, Authy, etc.). Scan the QR code to link your device. Once enabled, a 6-digit code is required at every login.
π Security & Privacy
Restore Canvassing is designed with the security and privacy of canvassing data as a first principle. Below is a plain-language summary of every mechanism in place to protect your organisation and the personal data you collect.
Application Security
π’
Fully Siloed Installations
Each organisation runs its own dedicated Restore Canvassing installation with its own isolated database. There is no shared multi-tenant environment β your canvassing data, resident records, and supporter contacts are completely separated from every other organisation using the platform.
π
Credential Security
All passwords are hashed using bcrypt (cost 12) β plain-text credentials are never stored or transmitted. Session cookies are set httponly, samesite=Strict, and secure on HTTPS to prevent session hijacking and cross-site request forgery. The server strips all sensitive fields (password hash, MFA secrets) from API responses before they reach the client.
π‘οΈ
Regular Penetration Testing
The Restore Canvassing application and underlying infrastructure are subject to regular independent penetration testing, with findings remediated promptly. Every database query uses parameterised statements, protecting against SQL injection. Input validation and role-based access checks are enforced server-side on every API endpoint β there is no way to escalate privileges through the client.
π
Two-Factor Authentication
Time-based one-time password (TOTP) two-factor authentication is available to all users and can be enforced organisation-wide by administrators. After repeated failed MFA attempts, accounts are automatically locked to prevent automated attacks. We strongly recommend enabling 2FA for all branch managers and administrators.
π«
Brute Force Protection
Login attempts are rate-limited by IP address. After 5 failed login attempts within a 30-minute window, further attempts from that IP are blocked. Failed login attempts, blocks, and account lockouts are all recorded in the audit trail. Invitation links expire after 24 hours and can only be used once.
π
Comprehensive Audit Trail
Every significant action in Restore Canvassing is logged: logins and logouts, failed login attempts, MFA events, user creation and deactivation, password resets, policy changes, data exports, and configuration updates. Audit logs are retained on the server and accessible to administrators, supporting accountability and compliance investigations.
Privacy Controls
π¦
You Own Your Data
The organisation that installs Restore Canvassing owns all data within their installation. Resident records, visit histories, supporter contact details, and canvassing analytics are yours entirely. No data is shared with, analysed by, or accessible to any central party. Full data export to CSV is available to administrators at any time from the Data Export panel.
π
Opt-In Location Sharing
Live GPS location sharing is entirely opt-in. Canvassers must explicitly enable location sharing in their profile settings β it is off by default. Branch managers can also disable GPS tracking for their entire branch from branch settings. When location sharing is off, no location data is collected, stored, or visible to managers on the live map.
πͺ
Do Not Visit Flag
Households can be marked Do Not Visit when a resident requests no further contact. This flag is respected across all canvassing sessions and visible to all canvassers β they are not prompted to knock. This supports residents' right to opt out of canvassing contact and helps your organisation respect those wishes consistently.
ποΈ
Right to Erasure
Individual resident records can be permanently deleted from the platform by branch managers and administrators. This supports your organisation's obligations under UK GDPR Article 17 (right to erasure) when a resident requests that their data be removed.
ποΈ
Role-Based Data Access
Canvassers only see households and residents in their assigned branch. Branch managers can only access data for their own branch β they cannot view other branches' canvassing records, supporter data, or user details. Only administrators have cross-branch visibility, and their actions are logged. There is no mechanism in the client to bypass these restrictions.
πΊοΈ
Data Residency
Restore Canvassing is a managed platform β Restore Canvassing operates the infrastructure on your behalf, and your organisation's data is hosted in dedicated, isolated storage. For UK political parties, all data is held on UK-based infrastructure, directly supporting compliance with UK GDPR and ICO guidance on political canvassing data.
β οΈ
Canvassing data β including voter contact details and political opinions β is sensitive personal data under UK GDPR Article 9. Ensure your organisation has a lawful basis for processing it, has registered with the ICO as required, and has an appropriate privacy notice in place. Your Data Protection Officer should review your use of this platform before go-live.