Bump version

* Started admin documentation

* Small correction

* Polish admin docs and reference from README.md

Co-authored-by: emacs <emacs@hp2530p.tradesystem.nl>
Co-authored-by: Sascha Ißbrücker <sascha.issbruecker@googlemail.com>

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v1.6.3 (07/04/2021)
+- [**bug**] relative names use the wrong "today" after day change [#107](https://github.com/sissbruecker/linkding/issues/107)
+
+---
+
 ## v1.6.2 (04/04/2021)
 - [**enhancement**] Expose `date_added` in UI [#85](https://github.com/sissbruecker/linkding/issues/85)
 - [**closed**] Archived bookmarks - no result when searching for a word which is used only as tag [#83](https://github.com/sissbruecker/linkding/issues/83)

README.md

@@ -97,10 +97,18 @@ The application runs in a web-server called [uWSGI](https://uwsgi-docs.readthedo
 
 Check the [options document](docs/Options.md) on how to configure your linkding installation.
 
+## Administration
+
+Check the [administration document](docs/Admin.md) on how to use the admin app that is bundled with linkding.
+
 ## Backups
 
 Check the [backups document](docs/backup.md) for options on how to create backups.
 
+## How To
+
+Check the [how-to document](docs/how-to.md) for tips and tricks around using linkding.
+
 ## API
 
 The application provides a REST API that can be used by 3rd party applications to manage bookmarks. Check the [API docs](docs/API.md) for further information.

docs/Admin.md

@@ -0,0 +1,65 @@
+# Administration
+
+This document describes how to make use of the admin app that comes as part of each linkding installation. This is the default Django admin app with some linkding specific customizations.
+
+The admin app provides several features that are not available in the linkding UI:
+- User management and user self-management
+- Bookmark and tag management, including bulk operations
+
+## Linkding administration page
+
+To open the Admin app, go the *Settings* view and click on the *Admin* tab. This should open a new window with the admin app.
+
+Alternatively you can open the URL directly by adding `/admin` to the URL of your linkding installation.
+
+## User management
+
+Go to the linkding administration page and select *Users*.
+Here you can add and delete users, and change the password of a user.
+
+Once you have added a user you can, if needed, give the user staff status, which means this user can also access the linkding administration page.
+
+This page also allows you to change your own password if necessary.
+
+## Bookmark management
+
+While the linkding UI itself now has a bulk edit feature for bookmarks you can also use the admin app to manage bookmarks or to do bulk operations. 
+
+In the main linkding administration page, choose *Bookmarks*.
+
+First select the bookmarks to operate on:
+
+- Specify a filter to determine which bookmarks to operate on:
+  - In the column *by username*, you can choose to filter for bookmarks for a specific user
+  - In the column *by is archived*, you can choose to filter for bookmarks that are either archived or not
+  - In the column *by tags*, you can choose to filter for specific tags
+  - In the search box you can also add a text filter (note that this doesn't use the same search syntax as the linkding UI itself)  
+
+Now a list of bookmarks which match your filter is displayed, each bookmark on a separate line.
+Each line starts with a checkbox.
+Either choose the individual bookmarks you want to do a bulk operation on, or choose the top checkbox to select all shown bookmarks.
+
+Open the "Action" select box to choose the desired bulk operation:
+
+- Delete
+- Archive
+- Unarchive
+
+Click the button next to the checkbox to execute the operation.
+
+## Tag management
+
+While linkding UI currently only allows to create or assign tags, you can use the admin app to manage your tags. This can be especially useful if you want to clean up your tag collection.
+
+In the main linkding administration page, choose *Tags*.
+
+Similar to bookmarks management described above you can now specify which tags to operate on by specifying a filter and then selecting the individual tags.
+
+Open the "Action" select box to choose the desired bulk operation:
+
+- Delete
+- Delete unused tags - this will only delete the selected tags that are currently not assigned to any bookmark
+
+Click the button next to the checkbox to execute the operation.
+
+Note that deleting a tag does not affect the bookmarks that are tagged with this tag, it only removes the tag from those bookmarks.

docs/how-to.md

@@ -0,0 +1,46 @@
+# How To
+
+Collection of tips and tricks around using linkding.
+
+## Using the bookmarklet on Android/Chrome
+
+This how-to explains the usage of the standard linkding bookmarklet on Android / Chrome. 
+
+Chrome on Android does not permit running bookmarklets in the same way you can on a desktop system. There is however a workaround that is explained here.
+
+**Note** that this only works with Chrome and not with other browsers on Android.
+
+Create a bookmark of your linkding deployment by clicking the star icon which you find in the three dots menu in the top right. Next you have to edit the bookmark. Edit the URL and replace it it with the bookmarklet code of your instance and give it an easy to type name like `bm` for bookmark or `ld` for linkding:
+
+```
+javascript: (function() { var bookmarkUrl = window.location; var applicationUrl = 'http://<YOUR_INSTANCE_HERE>/bookmarks/new'; applicationUrl += '?url=' + encodeURIComponent(bookmarkUrl); applicationUrl += '&auto_close'; window.open(applicationUrl);})();
+```
+
+Now when you are browsing the web and you want to save the current page as a bookmark to your linkding instance simply type `bm` into the address bar and select it from the results. The bookmarklet code will trigger and you will be redirected so save the current page.
+
+For more info see here: https://paul.kinlan.me/use-bookmarklets-on-chrome-on-android/
+
+## Create a share action on iOS for adding bookmarks to linkding
+
+This how-to explains how to make use of the app shortcuts iOS app to create a share action that can be used in Safari for adding bookmarks to your linkding instance.
+
+**In the shortcuts app:**
+- create new shortcut
+- go to shortcut details, enable to option to show the shortcut in share menu
+- from the available share input types only select "URL"
+- add Safari action "Display website in Safari" (paraphrasing, not sure how it's called in english)
+- for URL enter your linkding instance URL and specifically point to the new bookmark form, then add the shortcut input variable from the list of suggested variables after the URL parameter. Visually it should look something like this: `https://linkding.mydomain.com/bookmarks/new?url=[Shortcut input]`, where `[Shortcut input]` is a visual block that was inserted after selecting the shortcut input variable suggestion. This is basically a placeholder that will get replaced with the actual URL that you want to bookmark. See screenshot at the end for an example on how this looks.
+- save, give the shortcut a nice name + glyph
+
+Example of how the shortcut configuration should look:
+
+![Screenshot](/docs/ios-app-shortcut-example.png?raw=true "Screenshot demonstrating how to insert the input placeholder into the URL")
+
+**Using the share action from Safari:**
+- browse to the website that you want to share
+- click the share button
+- your new app shortcut should now be available as share action
+- select the app shortcut
+- this should open a new Safari overlay showing the add bookmark form with the URL field prefilled
+- after saving the bookmark you can close the overlay and continue browsing
+

requirements.prod.txt

@@ -2,10 +2,10 @@ beautifulsoup4==4.7.1
 certifi==2019.6.16
 chardet==3.0.4
 confusable-homoglyphs==3.2.0
-Django==2.2.18
+Django==2.2.20
 django-generate-secret-key==1.0.2
 django-picklefield==2.0
-django-registration==3.0.1
+django-registration==3.1.2
 django-sass-processor==0.7.3
 django-widget-tweaks==1.4.5
 djangorestframework==3.11.2
@@ -16,5 +16,5 @@ pytz==2019.1
 requests==2.22.0
 soupsieve==1.9.2
 sqlparse==0.3.0
-urllib3==1.25.3
+urllib3==1.25.8
 uWSGI==2.0.18

requirements.txt

@@ -2,13 +2,13 @@ beautifulsoup4==4.7.1
 certifi==2019.6.16
 chardet==3.0.4
 confusable-homoglyphs==3.2.0
-Django==2.2.18
+Django==2.2.20
 django-appconf==1.0.3
 django-compressor==2.3
-django-debug-toolbar==3.2
+django-debug-toolbar==3.2.1
 django-generate-secret-key==1.0.2
 django-picklefield==2.0
-django-registration==3.0.1
+django-registration==3.1.2
 django-sass-processor==0.7.3
 django-widget-tweaks==1.4.5
 djangorestframework==3.11.2
@@ -23,4 +23,4 @@ rjsmin==1.1.0
 six==1.12.0
 soupsieve==1.9.2
 sqlparse==0.3.0
-urllib3==1.25.3
+urllib3==1.25.8

version.txt

@@ -1 +1 @@
-1.6.3
+1.6.4