Skip to content

Commit 0db2c36

Browse files
committed
additional edits
1 parent 2461ad7 commit 0db2c36

File tree

1 file changed

+119
-112
lines changed

1 file changed

+119
-112
lines changed

documentation/reference/qfieldcloud/self_hosted/django_interface.en.md

Lines changed: 119 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tx_slug: documentation_reference_qfieldcloud_django_administration
77

88
## Managing Users
99

10-
### Adding Users
10+
### Adding
1111

1212
!!! Workflow
1313

@@ -16,196 +16,203 @@ tx_slug: documentation_reference_qfieldcloud_django_administration
1616

1717
!![](../../../assets/images/self_hosted/managing_organization_django_01.png,800px)
1818
3. Fill in the required fields, including "Username", "Password", "Email address", and any additional user information.
19-
**Note**: You can also set the user's "Timezone" and email notification preferences for project and organization changes.
19+
20+
!!! Tip
21+
You can also set the user's "Timezone" and email notification preferences for project and organization changes.
2022
4. Click "Save" to add the user, and you'll be redirected to the "People" page with a success message.
2123

2224
!![](../../../assets/images/self_hosted/managing_organization_django_02.png,800px)
2325

24-
* The "Password" field will show the hashed version of the password. If a system administrator wants to change it,
25-
just replace the contents with the new password, QFieldCloud will automatically handle it.
26+
!!! Tip
2627

27-
#### Deleting Users
28+
The "Password" field will show the hashed version of the password.
29+
If a system administrator wants to change it, just replace the contents with the new password, QFieldCloud will automatically handle it.
2830

29-
* In the "Core" pages, click on "People".
30-
* Select the user by clicking on their "Username".
31-
* Click the "Delete" button.
31+
### Deleting
3232

33-
!![](../../../assets/images/self_hosted/managing_organization_django_03.png,800px)
33+
!!! Workflow
3434

35-
* The screen will show you all the related objects that will be deleted. When you double check this is what you want, proceed with deletion by clicking "Yes, I'm sure".
35+
1. In the "Core" pages, click on "People".
36+
2. Select the user by clicking on their "Username".
37+
3. Click the "Delete" button.
3638

37-
!![](../../../assets/images/self_hosted/managing_organization_django_04.png,800px)
39+
!![](../../../assets/images/self_hosted/managing_organization_django_03.png,800px)
40+
4. The screen will show you all the related objects that will be deleted. When you double check this is what you want, proceed with deletion by clicking "Yes, I'm sure".
3841

39-
* You will be redirected to the "People" page with a success message.
42+
!![](../../../assets/images/self_hosted/managing_organization_django_04.png,800px)
43+
5. You will be redirected to the "People" page with a success message.
4044

41-
!![](../../../assets/images/self_hosted/managing_organization_django_05.png,800px)
45+
!![](../../../assets/images/self_hosted/managing_organization_django_05.png,800px)
4246

43-
#### Generating a Reset Password URL for a User
47+
### Generating a Reset Password URL
4448

45-
* Access the "People" in the "Core" pages.
46-
* Click on the "Username" of the user for whom you want to generate a reset password URL.
47-
* On the user's page to find the "Generate reset password URL" option.
49+
!!! Workflow
4850

49-
!![](../../../assets/images/self_hosted/managing_organization_django_06.png,800px)
51+
1. Access the "People" in the "Core" pages.
52+
2. Click on the "Username" of the user for whom you want to generate a reset password URL.
53+
3. On the user's page to find the "Generate reset password URL" option.
5054

51-
* The manager should send the URL to the user via email for password reset.
55+
!![](../../../assets/images/self_hosted/managing_organization_django_06.png,800px)
56+
4. The manager should send the URL to the user via email for password reset.
5257

53-
!![](../../../assets/images/self_hosted/managing_organization_django_07.png,800px)
58+
!![](../../../assets/images/self_hosted/managing_organization_django_07.png,800px)
5459

5560
## Managing Organizations
5661

57-
#### Adding Organizations
58-
59-
* Click on "Organizations" in the "Core" pages.
60-
* In the "Organizations" page, click "Add Organization".
61-
62-
!![](../../../assets/images/self_hosted/managing_organization_django_08.png,800px)
63-
64-
* Fill in the organization details, including "Username" for the organization name, "Email address" for the admin, and select the owner from the dropdown list.
65-
66-
!![](../../../assets/images/self_hosted/managing_organization_django_09.png,800px)
67-
68-
* Click "Save" to create the organization, and you'll receive a success message.
69-
70-
#### Deleting Organizations
62+
### Adding
7163

72-
* In the "Organizations" page, click on the organization's name.
64+
!!! Worflow
7365

74-
!![](../../../assets/images/self_hosted/managing_organization_django_10.png,800px)
66+
1. Click on "Organizations" in the "Core" pages.
67+
2. In the "Organizations" page, click "Add Organization".
7568

76-
* Find the "Delete" button.
69+
!![](../../../assets/images/self_hosted/managing_organization_django_08.png,800px)
70+
3. Fill in the organization details, including "Username" for the organization name, "Email address" for the admin, and select the owner from the dropdown list.
7771

78-
!![](../../../assets/images/self_hosted/managing_organization_django_11.png,800px)
72+
!![](../../../assets/images/self_hosted/managing_organization_django_09.png,800px)
73+
4. Click "Save" to create the organization, and you'll receive a success message.
7974

80-
* The screen will show you all the related objects that will be deleted.
81-
When you double check that this is what you want, proceed with deletion by clicking "Yes, I'm sure".
75+
### Deleting
8276

83-
!![](../../../assets/images/self_hosted/managing_organization_django_12.png,800px)
84-
85-
* You will be redirected to the "Organizations" page with a success message.
86-
87-
!![](../../../assets/images/self_hosted/managing_organization_django_13.png,800px)
77+
!!! Workflow
8878

89-
#### Adding Members to an Organization
79+
1. In the "Organizations" page, click on the organization's name.
9080

91-
* Go to the "Organizations" page and select the organization where you want to add members.
92-
* Open the "Organization members" tab and click "Add another Organization member".
81+
!![](../../../assets/images/self_hosted/managing_organization_django_10.png,800px)
82+
2. Find the "Delete" button.
9383

94-
!![](../../../assets/images/self_hosted/managing_organization_django_14.png,800px)
84+
!![](../../../assets/images/self_hosted/managing_organization_django_11.png,800px)
85+
3. The screen will show you all the related objects that will be deleted.
86+
When you double check that this is what you want, proceed with deletion by clicking "Yes, I'm sure".
9587

96-
* In the search bar, type the usernames of the users you want to add.
88+
!![](../../../assets/images/self_hosted/managing_organization_django_12.png,800px)
89+
4. You will be redirected to the "Organizations" page with a success message.
9790

98-
!![](../../../assets/images/self_hosted/managing_organization_django_15.png,800px)
91+
!![](../../../assets/images/self_hosted/managing_organization_django_13.png,800px)
9992

100-
* After finding the users, click on their names to add them to the "Organization Members" list.
101-
* Once all desired members are added, click to "Save" the updated data for the "Organization".
93+
### Adding Members
10294

103-
!![](../../../assets/images/self_hosted/managing_organization_django_16.png,800px)
95+
!!! Workflow
10496

105-
* You will be redirected to the "Organizations" page with a success message.
97+
1. Go to the "Organizations" page and select the organization where you want to add members.
98+
2. Open the "Organization members" tab and click "Add another Organization member".
10699

107-
#### Remove Members from an Organization
100+
!![](../../../assets/images/self_hosted/managing_organization_django_14.png,800px)
101+
3. In the search bar, type the usernames of the users you want to add.
108102

109-
* Go to the "Organizations" page and select the organization where you want to remove members.
110-
* Open the "Organization members" tab.
111-
* Activate the "Delete?" checkbox for the user you want to remove.
103+
!![](../../../assets/images/self_hosted/managing_organization_django_15.png,800px)
104+
4. After finding the users, click on their names to add them to the "Organization Members" list.
112105

113-
!![](../../../assets/images/self_hosted/managing_organization_django_17.png,800px)
106+
5. Once all desired members are added, click to "Save" the updated data for the "Organization".
114107

115-
* Click to "Save" the updated data for the "Organization".
108+
!![](../../../assets/images/self_hosted/managing_organization_django_16.png,800px)
109+
6. You will be redirected to the "Organizations" page with a success message.
116110

117-
!![](../../../assets/images/self_hosted/managing_organization_django_18.png,800px)
111+
### Remove Members
118112

119-
* You will be redirected to the "Organizations" with a success message.
113+
!!! Worfklow
120114

121-
#### Changing Roles of Members in the Organizations
115+
1. Go to the "Organizations" page and select the organization where you want to remove members.
116+
2. Open the "Organization members" tab.
117+
3. Activate the "Delete?" checkbox for the user you want to remove.
122118

123-
* Enter the organization where the user's role you want to change is located.
124-
* Open the "Organization members" tab.
125-
* In the "Role" field, click the dropdown and choose "Member" or "Admin".
119+
!![](../../../assets/images/self_hosted/managing_organization_django_17.png,800px)
120+
4. Click to "Save" the updated data for the "Organization".
126121

127-
!![](../../../assets/images/self_hosted/managing_organization_django_19.png,800px)
122+
!![](../../../assets/images/self_hosted/managing_organization_django_18.png,800px)
123+
5. You will be redirected to the "Organizations" with a success message.
128124

129-
* Select the role you want to assign to the user and click to "Save" the updated data for the "Organization".
130-
* You will be redirected to the "Organizations" with a success message.
125+
### Changing Roles of Members
131126

132-
#### Creating Teams
127+
!!! Workflow
133128

134-
* Access the "Teams" pages in the "Core" pages.
135-
* Click "Add Team".
129+
1. Enter the organization where the user's role you want to change is located.
130+
2. Open the "Organization members" tab.
131+
3. In the "Role" field, click the dropdown and choose "Member" or "Admin".
136132

137-
!![](../../../assets/images/self_hosted/managing_organization_django_20.png,800px)
133+
!![](../../../assets/images/self_hosted/managing_organization_django_19.png,800px)
134+
4. Select the role you want to assign to the user and click to "Save" the updated data for the "Organization".
135+
5. You will be redirected to the "Organizations" with a success message.
138136

139-
* Provide a name for the team in the "Username" field and select the organization where the team should belong.
137+
### Creating Teams
140138

141-
!![](../../../assets/images/self_hosted/managing_organization_django_21.png,800px)
139+
!!! Workflow
142140

143-
* In the "Team members" section, click "Add another Team member".
144-
* Search for and add the usernames of users you want in the team.
145-
* The people added to the Team must be member of the Team's Organization
141+
1. Access the "Teams" pages in the "Core" pages.
142+
2. Click "Add Team".
146143

147-
!![](../../../assets/images/self_hosted/managing_organization_django_22.png,800px)
144+
!![](../../../assets/images/self_hosted/managing_organization_django_20.png,800px)
145+
3. Provide a name for the team in the "Username" field and select the organization where the team should belong.
148146

149-
* Once all members are added, lick to "Save" the updated data for the "Team".
150-
* You will be redirected to the "Teams" page with a success message.
147+
!![](../../../assets/images/self_hosted/managing_organization_django_21.png,800px)
148+
4. In the "Team members" section, click "Add another Team member".
149+
5. Search for and add the usernames of users you want in the team.
150+
6. The people added to the Team must be member of the Team's Organization.
151151

152-
#### Deleting Teams
152+
!![](../../../assets/images/self_hosted/managing_organization_django_22.png,800px)
153+
7. Once all members are added, lick to "Save" the updated data for the "Team".
154+
8. You will be redirected to the "Teams" page with a success message.
153155

154-
* Enter the team by clicking on its name.
155-
* Click the "Delete" button.
156+
### Deleting Teams
156157

157-
!![](../../../assets/images/self_hosted/managing_organization_django_23.png,800px)
158+
!!! Worfklow
158159

159-
* The screen will show you all the related objects that will be deleted. When you double check this is what you want, proceed with deletion by clicking "Yes, I'm sure".
160+
1. Enter the team by clicking on its name.
161+
2. Click the "Delete" button.
160162

161-
!![](../../../assets/images/self_hosted/managing_organization_django_24.png,800px)
163+
!![](../../../assets/images/self_hosted/managing_organization_django_23.png,800px)
164+
3. The screen will show you all the related objects that will be deleted. When you double check this is what you want, proceed with deletion by clicking "Yes, I'm sure".
162165

163-
* You will be redirected to the Teams page with a success message.
166+
!![](../../../assets/images/self_hosted/managing_organization_django_24.png,800px)
167+
4. You will be redirected to the Teams page with a success message.
164168

165-
#### Removing Members from the Team
169+
### Removing Members from the Team
166170

167-
* Enter the team where you want to delete users.
168-
* In the team, activate the "Delete?" checkbox for the users you want to remove.
171+
!!! Workflow
169172

170-
!![](../../../assets/images/self_hosted/managing_organization_django_25.png,800px)
173+
1. Enter the team where you want to delete users.
174+
2. In the team, activate the "Delete?" checkbox for the users you want to remove.
171175

172-
* Click to "Save" the updated data for the "Team".
173-
* You will be redirected to the "Teams" page with a success message.
176+
!![](../../../assets/images/self_hosted/managing_organization_django_25.png,800px)
177+
3. Click to "Save" the updated data for the "Team".
178+
4. You will be redirected to the "Teams" page with a success message.
174179

175180
## Managing Projects
176181

177182
### Creating Projects
178183

179-
To create projects, follow either Method 1 or Method 2:
184+
There are two ways in which you can create projects, follow either Method 1 or Method 2.
185+
186+
!!! Workflow
180187

181-
#### Method 1: Convert a Local Project to a QFieldCloud Project
188+
**Method 1: Convert a Local Project to a QFieldCloud Project**
182189

183-
* In QGIS, access your project and open the QFieldSync plugin.
184-
* Click the "QFieldCloud Projects Overview" button.
185-
* Click "Create New Project".
190+
1. In QGIS, access your project and open the QFieldSync plugin.
191+
2. Click the "QFieldCloud Projects Overview" button.
192+
3. Click "Create New Project".
186193

187-
!![](../../../assets/images/self_hosted/managing_organization_django_26.png,800px)
194+
!![](../../../assets/images/self_hosted/managing_organization_django_26.png,800px)
188195

189-
* Choose the option to "Convert the currently open project to a cloud project".
196+
4. Choose the option to "Convert the currently open project to a cloud project".
190197

191-
!![](../../../assets/images/self_hosted/managing_organization_django_27.png,800px)
198+
!![](../../../assets/images/self_hosted/managing_organization_django_27.png,800px)
192199

193-
* Provide project details and select the organization.
194-
* Click "Create" to initiate the conversion.
200+
5. Provide project details and select the organization.
201+
6. Click "Create" to initiate the conversion.
195202

196-
!![](../../../assets/images/self_hosted/managing_organization_django_28.png,800px)
203+
!![](../../../assets/images/self_hosted/managing_organization_django_28.png,800px)
197204

198-
* Once completed, click "Ok".
199-
* The project will be listed in the "QFieldCloud Projects Overview".
200-
* In QFieldCloud, navigate to the "Projects" and inspect the project's information.
205+
7. Once completed, click "Ok".
206+
8. The project will be listed in the "QFieldCloud Projects Overview".
207+
9. In QFieldCloud, navigate to the "Projects" and inspect the project's information.
201208

202-
!![](../../../assets/images/self_hosted/managing_organization_django_29.png,800px)
209+
!![](../../../assets/images/self_hosted/managing_organization_django_29.png,800px)
203210

204-
#### Method 2: Creating an Empty Project
211+
**Method 2: Creating an Empty Project**
205212

206213
You can create Empty projects by using QFieldSync or directly in QFieldCloud.
207214

208-
##### 2.1. Creating an empty project QFieldCloud method
215+
#### 2.1. Creating an empty project QFieldCloud method
209216

210217
* Go to the "Projects" page and click "Add Project".
211218

0 commit comments

Comments
 (0)