Bump version

* Improve docs

* Improve docs

.dockerignore

@@ -5,13 +5,22 @@
 /node_modules
 /tmp
 /docs
+/static
+/build
 
 /.dockerignore
 /.gitignore
-/build-*.sh
 /Dockerfile
+/docker-compose.yml
+/*.sh
 /*.iml
-/package*.json
+/*.patch
+/*.md
+/*.js
+
+# Whitelist files needed in build or prod image
+!/rollup.config.js
+!/bootstrap.sh
 
 # Remove development settings
 /siteroot/settings/dev.py

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v1.4.0 (24/02/2021)
+- [**enhancement**] Improve admin utilization [#76](https://github.com/sissbruecker/linkding/issues/76)
+
+---
+
 ## v1.3.3 (18/02/2021)
 - [**closed**] Missing "description" request body parameter in API causes 500 [#78](https://github.com/sissbruecker/linkding/issues/78)
 

Dockerfile

@@ -1,22 +1,52 @@
-FROM python:3.7-slim-stretch
-
-# Install packages required for uswgi
-RUN apt-get update
-RUN apt-get -y install build-essential
-RUN apt-get -y install mime-support
-
-# Install requirements and uwsgi server for running python web apps
+FROM node:current-alpine AS node-build
 WORKDIR /etc/linkding
-COPY requirements.prod.txt ./requirements.txt
-RUN pip install -U pip
-RUN pip install -Ur requirements.txt
-
-# Copy application
+# install build dependencies
+COPY package.json package-lock.json ./
+RUN npm install -g npm && \
+    npm install
+# compile JS components
 COPY . .
+RUN npm run build
 
+
+FROM python:3.9-slim AS python-base
+RUN apt-get update && apt-get -y install build-essential
+WORKDIR /etc/linkding
+
+
+FROM python-base AS python-build
+# install build dependencies
+COPY requirements.txt requirements.txt
+RUN pip install -U pip && pip install -Ur requirements.txt
+# run Django part of the build
+COPY --from=node-build /etc/linkding .
+RUN python manage.py compilescss && \
+    python manage.py collectstatic --ignore=*.scss && \
+    python manage.py compilescss --delete-files
+
+
+FROM python-base AS prod-deps
+COPY requirements.prod.txt ./requirements.txt
+RUN mkdir /opt/venv && \
+    python -m venv --upgrade-deps --copies /opt/venv && \
+    /opt/venv/bin/pip install --upgrade pip wheel && \
+    /opt/venv/bin/pip install -Ur requirements.txt
+
+
+FROM python:3.9-slim as final
+RUN apt-get update && apt-get -y install mime-support
+WORKDIR /etc/linkding
+# copy prod dependencies
+COPY --from=prod-deps /opt/venv /opt/venv
+# copy output from build stage
+COPY --from=python-build /etc/linkding/static static/
+# copy application code
+COPY . .
 # Expose uwsgi server at port 9090
 EXPOSE 9090
-
+# Activate virtual env
+ENV VIRTUAL_ENV /opt/venv
+ENV PATH /opt/venv/bin:$PATH
 # Run bootstrap logic
 RUN ["chmod", "+x", "./bootstrap.sh"]
 CMD ["./bootstrap.sh"]

README.md

@@ -1,12 +1,29 @@
 #  linkding
 
-*linkding* is a simple bookmark service that you can host yourself. It supports managing bookmarks, categorizing them with tags and has a search function. It provides a bookmarklet for quickly adding new bookmarks while browsing the web. It also supports import / export of bookmarks in the Netscape HTML format. And that's basically it 🙂.
+*linkding* is a simple bookmark service that you can host yourself.
+It's designed be to be minimal, fast and easy to set up using Docker. 
 
 The name comes from:
 - *link* which is often used as a synonym for URLs and bookmarks in common language
 - *Ding* which is german for *thing*
 - ...so basically some thing for managing your links
 
+**Feature Overview:**
+- Tags for organizing bookmarks
+- Search by text or tags
+- Automatically provides titles and descriptions from linked websites 
+- Import and export bookmarks in Netscape HTML format
+- Bookmark archive
+- Extensions for [Firefox](https://addons.mozilla.org/de/firefox/addon/linkding-extension/) and [Chrome](https://chrome.google.com/webstore/detail/linkding-extension/beakmhbijpdhipnjhnclmhgjlddhidpe)
+- Bookmarklet that should work in most browsers
+- Easy to set up using Docker
+- Uses SQLite as database
+- Works without Javascript
+- ...but has several UI enhancements when Javascript is enabled
+- REST API for developing 3rd party apps
+- Admin panel for user self-service and bulk operations
+
+
 **Demo:** https://demo.linkding.link/ (configured with open registration)
 
 **Screenshot:**
@@ -15,7 +32,7 @@ The name comes from:
 
 ## Installation
 
-The easiest way to run linkding is to use [Docker](https://docs.docker.com/get-started/).  The Docker image should be compatible with ARM platforms, so it can be run on a Raspberry Pi.
+The easiest way to run linkding is to use [Docker](https://docs.docker.com/get-started/).  The Docker image is compatible with ARM platforms, so it can be run on a Raspberry Pi.
 
 There is also the option to set up the installation manually which I do not support, but can give some pointers on below.
 
@@ -49,7 +66,7 @@ docker-compose up -d
 
 ### User setup
 
-Finally you need to create a user so that you can access the frontend. Replace the credentials in the following command and run it:
+Finally you need to create a user so that you can access the application. Replace the credentials in the following command and run it:
 
 **Docker**
 ```shell
@@ -67,10 +84,6 @@ The command will prompt you for a secure password. After the command has complet
 
 If you can not or don't want to use Docker you can install the application manually on your server. To do so you can basically follow the steps from the *Development* section below while cross-referencing the `Dockerfile` and `bootstrap.sh` on how to make the application production-ready.
 
-### Options
-
-Check the [options document](Options.md) on how to configure your linkding installation.
-
 ### Hosting
 
 The application runs in a web-server called [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/) that is production-ready and that you can expose to the web. If you don't know how to configure your server to expose the application to the web there are several more steps involved. I can not support support the process here, but I can give some pointers on what to search for:
@@ -78,17 +91,17 @@ The application runs in a web-server called [uWSGI](https://uwsgi-docs.readthedo
 - open the port that the application is running on in your servers firewall
 - depending on your network configuration, forward the opened port in your network router, so that the application can be addressed from the internet using your public IP address and the opened port
 
-### Backups
+## Options
 
-For backups you have two options: manually or automatic.
+Check the [options document](docs/Options.md) on how to configure your linkding installation.
 
-For manual backups you can export your bookmarks from the UI and store them on a backup device or online service.
+## Backups
 
-For automatic backups you want to backup the applications database. As described above, for production setups you should [mount](https://stackoverflow.com/questions/23439126/how-to-mount-a-host-directory-in-a-docker-container) the `/etc/linkding/data` directory from the Docker container to a directory on your host system. You can then use a backup tool of your choice to backup the contents of that directory.
+Check the [backups document](docs/backup.md) for options on how to create backups.
 
 ## API
 
-The application provides a REST API that can be used by 3rd party applications to manage bookmarks. Check the [API docs](API.md) for further information.
+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.
 
 ## Troubleshooting
 

bookmarks/templates/bookmarks/empty_bookmarks.html

@@ -3,6 +3,6 @@
     <p class="empty-subtitle">
         You can get started by <a href="{% url 'bookmarks:new' %}">adding</a> bookmarks,
         <a href="{% url 'bookmarks:settings.data' %}">importing</a> your existing bookmarks or configuring the
-        <a href="{% url 'bookmarks:settings.integrations' %}">bookmarklet</a>.
+        <a href="{% url 'bookmarks:settings.integrations' %}">browser extension</a> or the <a href="{% url 'bookmarks:settings.integrations' %}">bookmarklet</a>.
     </p>
 </div>

bookmarks/templates/settings/integrations.html

@@ -7,8 +7,15 @@
 
         {# Integrations section #}
         <section class="content-area">
+            <h2>Browser Extension</h2>
+            <p>The browser extension allows you to quickly add new bookmarks without leaving the page that you are on. The extension is available in the official extension stores for:</p>
+            <ul>
+                <li><a href="https://addons.mozilla.org/de/firefox/addon/linkding-extension/" target="_blank">Firefox</a></li>
+                <li><a href="https://chrome.google.com/webstore/detail/linkding-extension/beakmhbijpdhipnjhnclmhgjlddhidpe" target="_blank">Chrome</a></li>
+            </ul>
+            <p>The extension is <a href="https://github.com/sissbruecker/linkding-extension" target="_blank">open source</a> as well, which enables you to build and manually load it into any browser that supports Chrome extensions.</p>
             <h2>Bookmarklet</h2>
-            <p>The bookmarklet is a quick way to add new bookmarks without opening the linkding application
+            <p>The bookmarklet is an alternative, cross-browser way to quickly add new bookmarks without opening the linkding application
                 first. Here's how it works:</p>
             <ul>
                 <li>Drag the bookmarklet below into your browsers bookmark bar / toolbar</li>

build-docker.sh

@@ -2,7 +2,6 @@
 
 version=$(<version.txt)
 
-./build-static.sh
 docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 \
   -t sissbruecker/linkding:latest \
   -t sissbruecker/linkding:$version \

docs/backup.md

@@ -0,0 +1,52 @@
+# Backups
+
+This page describes some options on how to create backups.
+
+## What to backup
+
+Linkding stores all data in a SQLite database, so all you need to backup are the contents of that database.
+
+The location of the database file is `data/db.sqlite3` in the application folder. 
+If you are using Docker then the full path in the Docker container is `/etc/linkding/data/db.sqlite`. 
+As described in the installation docs, you should mount the `/etc/linkding/data` folder to a folder on your host system, from which you then can execute the backup.
+
+Below, we describe several methods to create a backup of the database:
+
+- Manual backup using the export function from the UI
+- Create a copy of the SQLite databse with the SQLite backup function
+- Create a plain textfile with the contents of the SQLite database with the SQLite dump function
+
+Choose the method that fits you best.
+
+## Exporting from the UI
+
+The least technical option is to use the bookmark export in the UI.
+Go to the settings page and open the *Data* tab. 
+Then click on the *Download* button to download an HTML file containing all your bookmarks.
+You can backup this file on a drive, or an online file host.
+
+## Using the SQLite backup function
+
+Requires [SQLite](https://www.sqlite.org/index.html) to be installed on your host system.
+
+With this method you create a new SQLite database, which is a copy of your linkding database.
+This method uses the backup command in the [Command Line Shell For SQLite](https://sqlite.org/cli.html).
+```shell
+sqlite3 db.sqlite3 ".backup 'backup.sqlite3'"
+```
+After you have created the backup database `backup.sqlite` you have to move it to another system, for example with rsync.
+
+## Using the SQLite dump function
+
+Requires [SQLite](https://www.sqlite.org/index.html) to be installed on your host system.
+
+With this method you create a plain text file with the SQL statements to recreate the SQLite database.
+
+```shell
+sqlite3 db.sqlite3 .dump > backup.sql
+```
+
+As this is a plain text file you can commit it to any revision management system, like git.
+Using git you can commit the changes, followed by a git push to a remote repository.
+
+

requirements.prod.txt

@@ -1,22 +1,18 @@
 beautifulsoup4==4.7.1
 certifi==2019.6.16
 chardet==3.0.4
-Django==2.2.13
-django-appconf==1.0.3
-django-compressor==2.3
+confusable-homoglyphs==3.2.0
+Django==2.2.18
 django-generate-secret-key==1.0.2
 django-picklefield==2.0
 django-registration==3.0.1
 django-sass-processor==0.7.3
 django-widget-tweaks==1.4.5
-djangorestframework==3.11.1
+djangorestframework==3.11.2
 idna==2.8
 pyparsing==2.4.7
 pytz==2019.1
-rcssmin==1.0.6
 requests==2.22.0
-rjsmin==1.1.0
-six==1.12.0
 soupsieve==1.9.2
 sqlparse==0.3.0
 urllib3==1.25.3

requirements.txt

@@ -2,7 +2,7 @@ beautifulsoup4==4.7.1
 certifi==2019.6.16
 chardet==3.0.4
 confusable-homoglyphs==3.2.0
-Django==2.2.13
+Django==2.2.18
 django-appconf==1.0.3
 django-compressor==2.3
 django-generate-secret-key==1.0.2
@@ -10,7 +10,7 @@ django-picklefield==2.0
 django-registration==3.0.1
 django-sass-processor==0.7.3
 django-widget-tweaks==1.4.5
-djangorestframework==3.11.1
+djangorestframework==3.11.2
 idna==2.8
 libsass==0.19.2
 pyparsing==2.4.7

version.txt

@@ -1 +1 @@
-1.4.0
+1.4.1