mirrors/gotosocial
1
0
Fork 1
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-05-18 16:28:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

[frontend] Add discoverable flag to settings panel (#2235)

Browse source
This commit is contained in:
tobi 2023-09-29 13:01:36 +02:00 committed by GitHub
parent 536d9e482d
commit 736cd37caf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 153 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

102
docs/user_guide/settings.md
View file

@ -1,10 +1,10 @@
# Settings
GoToSocial provides a settings interface where you can update your post settings, add an avatar and header image, write a bio for your account, and so on.
GoToSocial provides a settings interface where you can update your post and profile settings, add an avatar and header image, write a bio for your account, and so on.
You can access the Settings at `https://my-instance.example.com/settings` with your own GoToSocial instance. It uses the same OAUTH mechanism as normal clients (with scope: admin), and as such can be accessed from anywhere, separately from your own instance, or ran locally. A public installation is available here: [https://gts.superseriousbusiness.org/settings](https://gts.superseriousbusiness.org).
You can access the Settings at `https://my-instance.example.com/settings` with your own GoToSocial instance. It uses the same OAuth mechanism as normal clients.
You will be prompted to log in with your email address and password after providing the instance url (auto-filled when using the page that comes with your instance).
You will be prompted to log in with your email address and password after providing the instance url.
## Profile
@ -16,29 +16,60 @@ In the profile section you can change your display name, avatar and header image
To set an avatar or header image, click on the `Browse` button in the appropriate section, and use the file browser to select an image.
Currently, supported image formats are `gif`, `png`, and `jpeg`/`jpg`.
Currently, supported image formats are `gif`, `png`, `webp`, and `jpeg`/`jpg`.
A preview of the image as it will appear on your profile will be shown. If you're happy with your choices, click on the `Save profile info` button at the bottom of the Profile Info section. If you navigate to your profile and refresh the page, your new avatar / header will be shown. It might take a bit longer for the update to federate out to remote instances.
A preview of the image as it will appear on your profile will be shown. If you're happy with your choices, click on the `Save profile info` button at the bottom of the page.
### Set Displayname and Bio
If you navigate to your profile and refresh the page, your new avatar / header will be shown. It might take a bit longer for the update to federate out to remote instances.
Your display name is a short handle shown alongside your username on your profile. While your username cannot be changed once it's created, your display name can. Your display name can also contain spaces, capital letters, emojis, and so on. It's a great place to put a nickname, full name, and/or pronouns. For example, if your username is `@miranda`, your display name could be something like `Miranda Priestly (she/her)`.
### Basic Information
#### Display Name
Your display name is a short handle shown alongside your username on your profile.
While your username cannot be changed once it's created, your display name can.
Your display name can also contain spaces, capital letters, emojis, and so on.
It's a great place to put a nickname or full name. For example, if your username is `@miranda`, your display name could be something like `Miranda Priestly`.
#### Bio
Your bio is a longer text that introduces your account and your self. Your bio is a good place to:
- Give an indication of the sort of things you post about
- Mention your approximate age / location
- Link to any of your other accounts or profiles elsewhere
- Describe your boundaries and preferences when it comes to other people interacting with you
- Link hashtags that you often use when you post
- Give an indication of the sort of things you post about.
- Mention your approximate age / location.
- Link to any of your other accounts or profiles elsewhere.
- Describe your boundaries and preferences when it comes to other people interacting with you.
- Link hashtags that you often use when you post.
The bio accepts either `plain` or `markdown` formatting. This is set by the default post format setting described in [User Settings](#user-settings).
The bio accepts either `plain` or `markdown` formatting. This is set by the default post format setting described in [Post Settings](#post-settings).
After updating your display name and bio, click on the `Save profile info` button at the bottom of the Profile Info section to save your changes.
#### Profile Fields
### Manually Approve Followe Requests / Lock Your Account
Profile fields are a series of name/value pairs that will appear on your profile, and be federated to remote instances.
At the bottom of the Profile Info section, there's a checkbox to manually approve follow requests.
This is a perfect place to put things like:
- Links to your website(s)
- Links to crowdfunding / donation pages
- Your age
- Pronouns
Some examples:
- Alias : handler walter
- My Website : https://example.org
- Age : 99
- Pronouns : she/her
- My other account : @someone@somewhere.com
### Visibility and Privacy
#### Manually Approve Follow Requests (aka Lock Your Account)
This checkbox allows you to decide whether or not you want to manually review follow requests to your account.
When this is **not checked**, new follow requests are approved automatically without your intervention. This is useful for more public-facing accounts or cases where you don't really post anything sensitive or private.
@ -48,14 +79,41 @@ This option is often referred to on the fediverse as "locking" your account.
After ticking or unticking the checkbox, be sure to click on the `Save profile info` button at the bottom to save your new settings.
### Enable RSS feed of Public posts
#### Enable RSS Feed of Public Posts
RSS feeds for users are disabled by default, but can be opted into with this checkbox. For more information see [RSS](./rss.md). It's important to note that this by-passes follow requests, allowing anyone to get updates on your public posts. This feed only includes posts set as 'Public' (see [Privacy Settings](./posts.md#privacy-settings)).
RSS feeds for users are disabled by default, but can be opted into with this checkbox. For more information see [RSS](./rss.md).
### Custom CSS
If enabled on your instance, [Custom CSS](./custom_css.md) allows you to theme the way your profile looks when visited through a browser. When this setting is not enabled, the field is hidden.
This feed only includes posts set as 'Public' (see [Privacy Settings](./posts.md#privacy-settings)).
## Settings
!!! warning
Exposing your RSS feed allows *anyone* to subscribe to updates on your Public posts anonymously, bypassing follows and follow requests.
#### Mark Account as Discoverable by Search Engines and Directories
This setting updates the 'discoverable' flag on your account.
Checking the discoverable box for your account does the following:
- Update robots meta tags for your account, allowing it to be indexed by search engines and appear in search engine results.
- Indicate to remote instances that your account may be included in public directories and indexes.
Turning on the discoverable flag may take a week or more to propagate; your account will not immediately appear in search engine results.
!!! tip
Discoverable is set to false by default for new accounts, to avoid exposing them to crawlers. Setting it to true is useful for public-facing accounts where you actually *want* to be crawled.
!!! info
The discoverable setting is about **discoverability of your account**, not searchability of your posts. It has nothing to do with indexing of your posts for search by Mastodon instances, or other federated instances that use full text search!
### Advanced
#### Custom CSS
If enabled on your instance by the instance administrator, [Custom CSS](./custom_css.md) allows you to theme the way your profile looks when visited through a browser.
When this setting is not enabled by the instance administrator, the text input box is read-only.
## Post Settings
![Screenshot of the user settings section, providing drop-down menu's to select default post settings, and form fields to change your password](../assets/user-settings-post-settings.png)
@ -81,4 +139,4 @@ For more information on the way GoToSocial manages passwords, please see the [Pa
## Admins
If your account has been promoted to admin, this interface will also show sections related to admin actions, see [Admin Settings](../admin/settings.md).
If your account has been promoted to admin, this interface will also show sections related to admin actions, see [Admin Settings](../admin/settings.md).

23
web/source/settings/style.css
View file

@ -343,9 +343,25 @@ section.with-sidebar > div, section.with-sidebar > form {
margin-bottom: 0.5rem;
}
.moreinfolink {
.docslink {
font-size: 0.9em;
}
.form-section-docs {
margin-top: 1rem;
margin-bottom: 0.5rem;
border-left: 0.2rem solid $border-accent;
padding-left: 0.4rem;
display: flex;
flex-direction: column;
gap: 0.2rem;
h3 {
margin: 0;
}
}
.labelinput .border {
border-radius: 0.2rem;
@ -429,11 +445,6 @@ section.with-sidebar > div, section.with-sidebar > form {
justify-content: center;
gap: 1rem;
h3 {
margin: 0;
margin-bottom: 0.3rem;
}
span {
font-style: italic;
}

70
web/source/settings/user/profile.js
View file

@ -82,6 +82,7 @@ function UserProfileForm({ data: profile }) {
customCSS: useTextInput("custom_css", { source: profile }),
bot: useBoolInput("bot", { source: profile }),
locked: useBoolInput("locked", { source: profile }),
discoverable: useBoolInput("discoverable", { source: profile}),
enableRSS: useBoolInput("enable_rss", { source: profile }),
fields: useFieldArrayInput("fields_attributes", {
defaultValue: profile?.source?.fields,
@ -109,24 +110,36 @@ function UserProfileForm({ data: profile }) {
/>
<div className="files">
<div>
<h3>Header</h3>
<FileInput
label="Header"
field={form.header}
accept="image/*"
/>
</div>
<div>
<h3>Avatar</h3>
<FileInput
label="Avatar"
field={form.avatar}
accept="image/*"
/>
</div>
</div>
</div>
<div className="form-section-docs">
<h3>Basic Information</h3>
<a
href="https://docs.gotosocial.org/en/latest/user_guide/settings/#basic-information"
target="_blank"
className="docslink"
rel="noreferrer"
>
Learn more about these settings (opens in a new tab)
</a>
</div>
<TextInput
field={form.displayName}
label="Name"
label="Display name"
placeholder="A GoToSocial user"
/>
<TextArea
@ -135,28 +148,53 @@ function UserProfileForm({ data: profile }) {
placeholder="Just trying out GoToSocial, my pronouns are they/them and I like sloths."
rows={8}
/>
<b>Profile fields</b>
<ProfileFields
field={form.fields}
/>
<div className="form-section-docs">
<h3>Visibility and privacy</h3>
<a
href="https://docs.gotosocial.org/en/latest/user_guide/settings/#visibility-and-privacy"
target="_blank"
className="docslink"
rel="noreferrer"
>
Learn more about these settings (opens in a new tab)
</a>
</div>
<Checkbox
field={form.locked}
label="Manually approve follow requests"
/>
<Checkbox
field={form.discoverable}
label="Mark account as discoverable by search engines and directories"
/>
<Checkbox
field={form.enableRSS}
label="Enable RSS feed of Public posts"
/>
<b>Profile fields</b>
<ProfileFields
field={form.fields}
/>
{!instanceConfig.allowCustomCSS ? null :
<TextArea
field={form.customCSS}
label="Custom CSS"
className="monospace"
rows={8}
<div className="form-section-docs">
<h3>Advanced</h3>
<a
href="https://docs.gotosocial.org/en/latest/user_guide/settings/#advanced"
target="_blank"
className="docslink"
rel="noreferrer"
>
<a href="https://docs.gotosocial.org/en/latest/user_guide/custom_css" target="_blank" className="moreinfolink" rel="noreferrer">Learn more about custom profile CSS (opens in a new tab)</a>
</TextArea>
}
Learn more about these settings (opens in a new tab)
</a>
</div>
<TextArea
field={form.customCSS}
label="Custom CSS"
className="monospace"
rows={8}
disabled={!instanceConfig.allowCustomCSS}
/>
<MutationButton label="Save profile info" result={result} />
</form>
);

4
web/source/settings/user/settings.js
View file

@ -81,7 +81,7 @@ function UserSettingsForm({ data }) {
<option value="public">Public</option>
</>
}>
<a href="https://docs.gotosocial.org/en/latest/user_guide/posts/#privacy-settings" target="_blank" className="moreinfolink" rel="noreferrer">Learn more about post privacy settings (opens in a new tab)</a>
<a href="https://docs.gotosocial.org/en/latest/user_guide/posts/#privacy-settings" target="_blank" className="docslink" rel="noreferrer">Learn more about post privacy settings (opens in a new tab)</a>
</Select>
<Select field={form.statusContentType} label="Default post (and bio) format" options={
<>
@ -89,7 +89,7 @@ function UserSettingsForm({ data }) {
<option value="text/markdown">Markdown</option>
</>
}>
<a href="https://docs.gotosocial.org/en/latest/user_guide/posts/#input-types" target="_blank" className="moreinfolink" rel="noreferrer">Learn more about post format settings (opens in a new tab)</a>
<a href="https://docs.gotosocial.org/en/latest/user_guide/posts/#input-types" target="_blank" className="docslink" rel="noreferrer">Learn more about post format settings (opens in a new tab)</a>
</Select>
<Checkbox
field={form.isSensitive}