FossilRepo

fossilrepo / docs / getting-started / administration.md
Source Blame History 131 lines
45192ef… ragelink 1 # Administration
45192ef… ragelink 2
45192ef… ragelink 3 ## User Management
45192ef… ragelink 4
45192ef… ragelink 5 Navigate to **Admin > Members** in the sidebar.
45192ef… ragelink 6
45192ef… ragelink 7 ### Creating Users
45192ef… ragelink 8 1. Click "Create User"
45192ef… ragelink 9 2. Fill in username, email, name, password
45192ef… ragelink 10 3. Optionally assign an org role
45192ef… ragelink 11 4. User is automatically added as an organization member
45192ef… ragelink 12
45192ef… ragelink 13 ### Editing Users
45192ef… ragelink 14 Click a username to view their profile, then "Edit" to change:
45192ef… ragelink 15 - Name, email
45192ef… ragelink 16 - Active/inactive status
45192ef… ragelink 17 - Staff status (access to Super Admin)
45192ef… ragelink 18 - Org role assignment
45192ef… ragelink 19
45192ef… ragelink 20 ### Changing Passwords
45192ef… ragelink 21 From the user detail page, click "Change Password". Admins can change any user's password. Users can change their own password from their profile page.
45192ef… ragelink 22
45192ef… ragelink 23 ### Deactivating Users
45192ef… ragelink 24 Edit the user and uncheck "Active". This prevents login without deleting the account. The user's history and contributions are preserved.
45192ef… ragelink 25
45192ef… ragelink 26 ## Roles
45192ef… ragelink 27
45192ef… ragelink 28 Navigate to **Admin > Roles** in the sidebar.
45192ef… ragelink 29
45192ef… ragelink 30 ### Predefined Roles
45192ef… ragelink 31
45192ef… ragelink 32 | Role | Access Level |
45192ef… ragelink 33 |------|-------------|
45192ef… ragelink 34 | Admin | Full access to everything |
45192ef… ragelink 35 | Manager | Manage projects, teams, members, pages |
45192ef… ragelink 36 | Developer | Contribute: view projects, create tickets |
45192ef… ragelink 37 | Viewer | Read-only access to all content |
45192ef… ragelink 38
45192ef… ragelink 39 ### Custom Roles
45192ef… ragelink 40 Click "Create Role" to define a custom role with a specific permission set. The permission picker groups permissions by app (Organization, Projects, Pages, Fossil).
45192ef… ragelink 41
45192ef… ragelink 42 ### Initializing Roles
45192ef… ragelink 43 If no roles exist, click "Initialize Roles" to create the four predefined roles. This runs the `seed_roles` management command.
45192ef… ragelink 44
45192ef… ragelink 45 ### How Roles Work
45192ef… ragelink 46 Each role maps to a Django Group with the same permissions. When a user is assigned a role, their previous role group is removed and the new one added. Permissions are synced automatically.
45192ef… ragelink 47
45192ef… ragelink 48 ## Teams
45192ef… ragelink 49
45192ef… ragelink 50 Navigate to **Admin > Teams** in the sidebar.
45192ef… ragelink 51
45192ef… ragelink 52 Teams are groups of users that can be assigned to projects with specific access levels.
45192ef… ragelink 53
45192ef… ragelink 54 ### Creating Teams
45192ef… ragelink 55 1. Click "New Team"
45192ef… ragelink 56 2. Enter name and description
45192ef… ragelink 57 3. Add members from the user list
45192ef… ragelink 58
45192ef… ragelink 59 ### Assigning Teams to Projects
45192ef… ragelink 60 1. Go to the project overview
45192ef… ragelink 61 2. Click the project name > Teams section
45192ef… ragelink 62 3. Click "Add Team"
45192ef… ragelink 63 4. Select team and role (read/write/admin)
45192ef… ragelink 64
45192ef… ragelink 65 ## Project Groups
45192ef… ragelink 66
45192ef… ragelink 67 Navigate to **Admin > Groups** in the sidebar.
45192ef… ragelink 68
45192ef… ragelink 69 Groups organize related projects together in the sidebar. For example, "Fossil SCM" group might contain the source code repo, forum repo, and docs repo.
45192ef… ragelink 70
45192ef… ragelink 71 ### Creating Groups
45192ef… ragelink 72 1. Click "Create Group"
45192ef… ragelink 73 2. Enter name and description
45192ef… ragelink 74 3. Assign projects to the group via the project edit form
45192ef… ragelink 75
45192ef… ragelink 76 ## Organization Settings
45192ef… ragelink 77
45192ef… ragelink 78 Navigate to **Admin > Settings** in the sidebar.
45192ef… ragelink 79
45192ef… ragelink 80 Configure the organization name, website, and description. This appears in the site header and various admin pages.
45192ef… ragelink 81
45192ef… ragelink 82 ## Audit Log
45192ef… ragelink 83
45192ef… ragelink 84 Navigate to **Admin > Audit Log** in the sidebar.
45192ef… ragelink 85
45192ef… ragelink 86 Shows all model changes across the application, powered by django-simple-history. Filter by model type to see changes to specific entities.
45192ef… ragelink 87
45192ef… ragelink 88 ## Super Admin
45192ef… ragelink 89
45192ef… ragelink 90 Navigate to **Admin > Super Admin** in the sidebar.
45192ef… ragelink 91
45192ef… ragelink 92 This is Django's built-in admin interface. Use it for:
45192ef… ragelink 93 - Direct database access to any model
45192ef… ragelink 94 - Constance runtime settings
45192ef… ragelink 95 - Celery task results and beat schedule
45192ef… ragelink 96 - Advanced permission management
45192ef… ragelink 97 - Data import/export
45192ef… ragelink 98
45192ef… ragelink 99 Most day-to-day operations should be done through the main UI, not Super Admin.
45192ef… ragelink 100
45192ef… ragelink 101 ## Project Settings
45192ef… ragelink 102
45192ef… ragelink 103 Each project has its own settings tab (visible to project admins):
45192ef… ragelink 104
45192ef… ragelink 105 ### Repository Info
45192ef… ragelink 106 - Filename, file size, project code, checkin/ticket/wiki counts
45192ef… ragelink 107
45192ef… ragelink 108 ### Remote URL
45192ef… ragelink 109 - Configure upstream Fossil remote for pull/push/sync
45192ef… ragelink 110
45192ef… ragelink 111 ### Clone URLs
45192ef… ragelink 112 - HTTP clone URL for users
45192ef… ragelink 113 - SSH clone URL
45192ef… ragelink 114
45192ef… ragelink 115 ### Tokens
45192ef… ragelink 116 - Project-scoped API tokens for CI/CD integration
45192ef… ragelink 117
45192ef… ragelink 118 ### Branch Protection
45192ef… ragelink 119 - Per-branch rules: restrict push, require CI status checks
45192ef… ragelink 120
45192ef… ragelink 121 ### Webhooks
45192ef… ragelink 122 - Outbound webhooks on repository events
45192ef… ragelink 123
45192ef… ragelink 124 ## Notification Settings
45192ef… ragelink 125
45192ef… ragelink 126 Users configure their own notification preferences at **/auth/notifications/**:
45192ef… ragelink 127
45192ef… ragelink 128 - **Delivery mode**: Immediate, Daily Digest, Weekly Digest, Off
45192ef… ragelink 129 - **Event types**: Checkins, Tickets, Wiki, Releases, Forum
45192ef… ragelink 130
45192ef… ragelink 131 Admins can view user preferences via Super Admin.

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button