Skip to content
Snippets Groups Projects
Verified Commit 22007e8f authored by anarcat's avatar anarcat
Browse files

start testing Vale, on service/nextcloud.md

This is pretty good, but really requires an extensive
dictionary. Right now, we use a "vocabulary", but eventually we might
want to make our own "style" with multiple plugins, in particular
because this would allow us to split the dictionnaries between
different things, like "usernames", "tech" and who knows. Right now
it's all bundled up in the same file, but as it grows, it will become
impractical.

Right now, running vale over the entire wiki yields:

:heavy_multiplication_x: 5742 errors, 0 warnings and 0 suggestions in 222 files.

In comparison, codespell finds zero errors, which is suspicious,
because there *are* errors, if only capitalisation inconsistencies,
but also actual typos like `occured`.

This is not yet in GitLab CI because i don't want to break the
pipeline right off the bat. I also feel we're getting enough into
linting that we should start looking at pre-commit so that those hooks
are correctly run on the client side before push.
parent e98c6549
No related branches found
No related tags found
No related merge requests found
StylesPath = .vale
MinAlertLevel = suggestion
Vocab = tpa
[*.md]
BasedOnStyles = Vale
[Aa]narcat
Ansible
Arti
calcurses
colocation
cState
Debian
DRBD
gaba
Gandi
Ganeti
GitHub
GitLab
Gitolite
Gmail
Gollum
Greasemonkey
Hetzner
Hugo
iCal
ikhal
ikiwiki
Inkscape
IPSec
Isabela
Kaniko
kez
khal
Korganizer
lavamind
lego
Lektor
Linaro
mdBook
MediaWiki
mkdocs
Nagios
Nextcloud
Nitrokey
NVMe
PCIe
pgbarman
Podman
Pospesel
Riseup
Scaleway
Sunet
Supermicro
TPA
Trac
vdirsyncer
VLAN
WikiMedia
Yubico
YubiKey
[[_TOC_]]
Tor Project is using [NextCloud](https://nc.torproject.net/) as a tool for managing and sharing
Tor Project is using [Nextcloud](https://nc.torproject.net/) as a tool for managing and sharing
resources and for collaborative editing.
Questions and bug reports are handled by Tor's NextCloud service admin
Questions and bug reports are handled by Tor's Nextcloud service admin
team. For bug reports, please [create a ticket][] in the
`Service - nextcloud` component in [Trac](https://trac.torproject.org/). For questions, find us
`Service - Nextcloud` component in [Trac](https://trac.torproject.org/). For questions, find us
on IRC (GeKo, ln5, pospeselr, anarcat, gaba) or send email to
`nextcloud-admin@torproject.org`.
......@@ -46,33 +46,33 @@ on IRC (GeKo, ln5, pospeselr, anarcat, gaba) or send email to
1. Enter a name for the device and click "Add"
1. Log out and log in again, to verify that you got two factor
authentication working.
1. In NextCloud, select Settings -> Security. The link to your
1. In Nextcloud, select Settings -> Security. The link to your
settings can be found by clicking on your "user icon" in the top
right corner. Direct link: [Settings -> Security](https://nc.torproject.net/settings/user/security).
1. Click "Generate Backup codes" in the Two-Factor Authentication
section of that page.
1. Save your backup codes to a password manager of your
choice. These will be needed to regain access to your NextCloud
choice. These will be needed to regain access to your Nextcloud
account if you ever lose your 2FA token/application.
## A note on credentials
**_Don't let other people use your credentials.**_ Not even people you
know and like. If you know someone who should have a NextCloud
_**Don't let other people use your credentials.**_ Not even people you
know and like. If you know someone who should have a Nextcloud
account, let the service admins know in [a ticket][create a ticket].
**_Don't let other _other_ people use your credentials.**_ Never enter
_**Don't let _other_ people use your credentials.**_ Never enter
your passphrase or two-factor code on any other site than Tor
Project's NextCloud site. Lower the risk of entering your credentials
Project's Nextcloud site. Lower the risk of entering your credentials
to the wrong site by verifying that there's a green padlock next to
the URL and that the URL is indeed correct.
**_Don't lose your credentials.**_ This is especially important since
_**Don't lose your credentials.**_ This is especially important since
files are _encrypted_ in a key derived from your passphrase. To help
deal with when a phone or hardware token is lost, you should really
(really!) generate **Backup codes** and store those in a safe place,
together with your passphrase. Backup codes can be used to restore
access to your NextCloud and encrypted files. There is no other way of
access to your Nextcloud and encrypted files. There is no other way of
accessing encrypted files! Backup codes can be generated from the
[Settings -> Security](https://nc.torproject.net/settings/user/security) page.
......@@ -81,8 +81,8 @@ accessing encrypted files! Backup codes can be generated from the
In the top left of the header-bar, you should see a "Folder" icon;
when moused over a text label should appear beneath it that says
Files. When clicked, you will be taken to the **Files** app and placed
in the root of your NextCloud file directory. Here, you can upload
local files to NextCloud, download remote files to your local storage,
in the root of your Nextcloud file directory. Here, you can upload
local files to Nextcloud, download remote files to your local storage,
and share remote files across the internet. You can also perform the
various file management operations (move, rename, copy, etc) you are
familiar with in Explorer on Windows or Finder on macOS.
......@@ -99,20 +99,20 @@ helpful views of your files.
### Upload a file
Local files saved on your computer can be uploaded to NextCloud. To
Local files saved on your computer can be uploaded to Nextcloud. To
upload a file:
1. In the NextCloud **Files** app, navigate to the folder where you
1. In the Nextcloud **Files** app, navigate to the folder where you
want to store the file
1. Click on the circular button with a **+** inside it (to the right
of the little house icon)
1. Click **Upload file** entry in the context menu
1. Select a file to upload using your system's file browser window
### Share a file or directory with another NextCloud user
### Share a file or directory with another Nextcloud user
Files stored in your NextCloud file directory can be selectively
shared with other NextCloud users. To share a file:
Files stored in your Nextcloud file directory can be selectively
shared with other Nextcloud users. To share a file:
1. Locate the file you wish to share (either by navigating to the
folder it is in, by searching, or by using one of the views in the
......@@ -120,8 +120,8 @@ shared with other NextCloud users. To share a file:
1. Click the file's **Share** icon (to the right of the file name)
1. In the pane that pops out from the right, click on the search box
labeled **Name, federated cloud ID or email address…**
1. Search for the user or group you wish to share with by NextCloud
user id (pospeselr), email address (richard@torproject.org), or
1. Search for the user or group you wish to share with by Nextcloud
user id (`pospeselr`), email address (`richard@torproject.org`), or
name (Richard Pospesel) and select them from the dropdown.
1. Optional: click on the meatball menu to the right of the shared
user and edit the sharing options associated with the file or
......@@ -131,9 +131,9 @@ shared with other NextCloud users. To share a file:
### Share a file with the internet
Files can also be shared with the internet via a url. Files shared in
Files can also be shared with the internet via a URL. Files shared in
this fashion are read-only by default, but be mindful of what you
share: **by default, anyone who knows the link url can download the
share: **by default, anyone who knows the link URL can download the
file**. To share a file:
1. Locate the file you wish to share
......@@ -153,7 +153,7 @@ file**. To share a file:
### Un-share files or edit their permissions
If you have shared files or folders with either the internet or
another NextCloud user, you can un-share them. To un-share a file:
another Nextcloud user, you can un-share them. To un-share a file:
1. Locate the file you wish to un-share in the **Files** app
* All of your currently shared files and folders can be found from the **Shares** view
......@@ -211,25 +211,25 @@ create and hit enter, or the arrow.
### A few gotchas with collaborative editing
Behind the scenes, when a user opens a document for editing, the
document is being copied from the NextCloud server to the document
document is being copied from the Nextcloud server to the document
editing server. Once all editing sessions are closed, the document is
being copied back to NextCloud. This behavior makes the following
being copied back to Nextcloud. This behavior makes the following
information important.
* **_The document editing server copies documents from NextCloud**_,
* _**The document editing server copies documents from Nextcloud**_,
so while a document is open for editing it will differ from the
version stored in NextCloud. The effect of this is that downloads
from NextCloud will show a different version than the one currently
version stored in Nextcloud. The effect of this is that downloads
from Nextcloud will show a different version than the one currently
being edited.
* **_A document is stored back to NextCloud 10 seconds after all
* _**A document is stored back to Nextcloud 10 seconds after all
editing sessions for that document have finished.**_ This means
that as long as there's a session open, active or idle, the
versions will differ. If either the document server breaks or the
connection between NextCloud and the document server breaks it is
possible that there'll be data loss.
connection between Nextcloud and the document server breaks it is
possible that there will be data loss.
* **_An idle editing session expires after 5 minutes.**_ This helps
* _**An idle editing session expires after 5 minutes.**_ This helps
making sure the document will not hang indefinitely in the document
editing server even if a user leaves a browser tab open.
......@@ -264,7 +264,7 @@ which could be of interest.
First create a Nextcloud "App" password by logging into the Nextcloud web interface, and then go to your profile->Settings->Security->Create a new App Password. Give it a name and then copy the randomly generated password (you cannot see the password again after you are finished!), then click Done.
Install DAVx^5 from [F-Droid](https://f-droid.org/en/packages/at.bitfire.davdroid/) or the [Playstore](https://play.google.com/store/apps/details?id=at.bitfire.davdroid&referrer=utm_source%3Dhomepage) This program will synchronize with nextcloud your calendars and contacts and is Free. Launch it and press the "+" to add a new account. Pick "Login with URL and username". Set Base URL: "nc.torproject.org", put your nextcloud username into "Username" and then the App password that you generated previously into the "Password" field, click Login. Under Create Account, make your Account name your email address, then click Create Account. Then click the CalDAV tab and select the calendars you wish to sync and then press the round orange button with the two arrows in the bottom right to begin the synchronization. You can also sync your contacts, if you store them in Nextcloud, by clicking the CardDav tab and selecting things there.
Install DAVx^5 from [F-Droid](https://f-droid.org/en/packages/at.bitfire.davdroid/) or the [Play store](https://play.google.com/store/apps/details?id=at.bitfire.davdroid&referrer=utm_source%3Dhomepage) This program will synchronize with Nextcloud your calendars and contacts and is Free. Launch it and press the "+" to add a new account. Pick "Login with URL and username". Set Base URL: "nc.torproject.org", put your Nextcloud username into "Username" and then the App password that you generated previously into the "Password" field, click Login. Under Create Account, make your Account name your email address, then click Create Account. Then click the CalDAV tab and select the calendars you wish to sync and then press the round orange button with the two arrows in the bottom right to begin the synchronization. You can also sync your contacts, if you store them in Nextcloud, by clicking the CardDav tab and selecting things there.
For more information, [check the Nextcloud documentation](https://docs.nextcloud.com/server/latest/user_manual/en/groupware/sync_android.html)
......@@ -277,7 +277,7 @@ two-factor-authentication enabled on their account.
2. Select Settings
3. On the left bar, select Security
4. A list of topics will appear: “Password, Two-factor
Authentication, Passwordless Authentication, Devices & Session”
Authentication, Password-less Authentication, Devices & Session”
5. Go to Devices & Session, on the field “App name” create a name for
your phone, like “iPhone Calendar” and click on “Create new app
password”
......@@ -299,8 +299,7 @@ Then, you can follow the Nextcloud settings, take your phone:
Done!
Note: the above instructions come from [this tutorial by Narrira
Lemos](https://narrira.medium.com/sync-your-nextcloud-calendar-on-iphone-398aecc2d5bc).
Note: the above instructions come from [this tutorial](https://narrira.medium.com/sync-your-nextcloud-calendar-on-iphone-398aecc2d5bc).
### Mac, Windows, Linux: Thunderbird
......@@ -312,9 +311,9 @@ In order to use the calendar, you need to first generate an App password, and th
First create a Nextcloud "App" password by logging into the Nextcloud web interface, and then go to your profile->Settings->Security->Create a new App Password. Give it a name and then copy the randomly generated password (you cannot see the password again after you are finished!), then click Done. Note: if you did this previously for Android, its not a bad idea to have a separate App Password for Thunderbird, that way you can revoke the Android password, if you lose your device, and still have access to your Thunderbird calendar.
Simply go to Tools->Addons and Themes->Search->Tbsync install. Then in the Tbsync preferences -> Account Actions -> Add new account -> Caldav & CardDav -> install the plugin for this connector.
Simply go to Tools->Addons and Themes->Search->`Tbsync` install. Then in the `Tbsync` preferences -> Account Actions -> Add new account -> CalDAV & CardDAV -> install the plugin for this connector.
Then under the Tbsync preferences, you pick "Account actions" in the lower left, then "Add new account" -> "CalDAV & CardDAV". Then pick "Automatic Configuration". Put an account name (your choice), your Nextcloud username, your App Password you generated previously and then for Server URL, just put "nc.torproject.org" and click "Next".
Then under the `Tbsync` preferences, you pick "Account actions" in the lower left, then "Add new account" -> "CalDAV & CardDAV". Then pick "Automatic Configuration". Put an account name (your choice), your Nextcloud username, your App Password you generated previously and then for Server URL, just put "nc.torproject.org" and click "Next".
Now just select the calendars you wish to synchronize and click "Synchronize now", and you should be all set.
......@@ -328,9 +327,9 @@ be good choices depending on your favorite Linux desktop.
Untested. GNOME Calendar doesn't display time zones which is probably
a deal breaker.
### Commandline tools: vdirsyncer, ikhal, calcurses
### Command line tools: vdirsyncer, ikhal, calcurses
[vdirsyncer](https://github.com/pimutils/vdirsyncer) is the hardcode, commandline tool to synchronize
[vdirsyncer](https://github.com/pimutils/vdirsyncer) is the hardcore, command line tool to synchronize
calendars from a remote CalDAV server to a local directory, and
back. It does nothing else. vdirsyncer is somewhat tricky to configure
and to use, and doesn't deal well with calendars that disappear.
......@@ -350,13 +349,13 @@ TODO
## Showing UTC times in weekly calendar view
This [TimeZoneChallenged.user.js](https://people.torproject.org/~ma1/userscripts/TimeZoneChallenged.user.js) [GreaseMonkey script](https://www.greasespot.net/) allows
This [TimeZoneChallenged.user.js](https://people.torproject.org/~ma1/userscripts/TimeZoneChallenged.user.js) [Greasemonkey script](https://www.greasespot.net/) allows
you to see the UTC time next to your local time in the left column of
the Nextcloud Calendar's "weekly" view.
To install it:
1. [install the Greasmonkey add-on](https://addons.mozilla.org/firefox/addon/greasemonkey/) if not already done
1. [install the Greasemonkey add-on](https://addons.mozilla.org/firefox/addon/greasemonkey/) if not already done
2. in the extension, select "new user script"
3. copy paste the above script and save
4. in the extension, select the script, then "user script options"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment