Merge branch 'master' into guestupload

Author: Forceu

docs/advanced.rst

@@ -144,14 +144,14 @@ To switch to a different database, Gokapi provides a migration tool. By running:
 
 ::
 
- gokapi --migrate [old Database URL] [new Database URL]
+ gokapi migrate-database --source [old Database URL] --destination [new Database URL]
  
 all existing data, except for user sessions, will be transferred to the new database. After the migration, you will need to rerun the setup and specify the new database location. For details on the correct database URL format, refer to the section :ref:`databaseUrl`.
 
 For Docker users, the command is:
 ::
 
- docker run --rm -v gokapi-data:/app/data f0rc3/gokapi:latest /app/run.sh [old Database URL] [new Database URL]
+ docker run --rm -v gokapi-data:/app/data f0rc3/gokapi:latest /app/run.sh migrate-database --source [old Database URL] --destination [new Database URL]
 
 
 .. _databaseUrl:
@@ -190,20 +190,20 @@ Migrating SQLite (``/app/data/gokapi.sqlite``) to Redis (``127.0.0.1:6379``):
 
 ::
 
- gokapi --migrate sqlite:///app/data/gokapi.sqlite redis://127.0.0.1:6379
+ gokapi migrate-database --source sqlite:///app/data/gokapi.sqlite --destination redis://127.0.0.1:6379
 
 Migrating SQLite (``/app/data/gokapi.sqlite``) to SQLite (``./data/gokapi.sqlite``):
 
 ::
 
- gokapi --migrate sqlite:///app/data/gokapi.sqlite sqlite://./data/gokapi.sqlite
+ gokapi migrate-database --source sqlite:///app/data/gokapi.sqlite --destination sqlite://./data/gokapi.sqlite
  
 Migrating Redis (``127.0.0.1:6379, User: test, Password: 1234, Prefix: gokapi_, using SSL``) to SQLite (``./data/gokapi.sqlite``):
 
 
 ::
 
- gokapi --migrate "redis://test:1234@127.0.0.1:6379?prefix=gokapi_&ssl=true" sqlite://./data/gokapi.sqlite
+ gokapi migrate-database --source "redis://test:1234@127.0.0.1:6379?prefix=gokapi_&ssl=true" --destination sqlite://./data/gokapi.sqlite
 
 
 

docs/setup.rst

@@ -147,7 +147,7 @@ During the first start, a new configuration file will be created and you will be
 
 Database
 """"""""""""""
-By default, Gokapi stores its data in a database located in the ``data`` directory. You can specify a different database location in this menu. If no changes are needed, you can proceed as is. Redis is recommended for servers with a high frequency of downloads.
+By default, Gokapi stores its data in a SQLite database located in the ``data`` directory. You can specify a different database location in this menu. If you expect a high frequency of downloads or uploads or if your instance has a slow disk, using **Redis is strongly recommended instead of SQLite**.
 
 You can configure the following settings:
 
@@ -159,6 +159,10 @@ You can configure the following settings:
 -  **Password (optional)** Enter the password for database connection.
 -  **Use SSL** Select this option to establish an SSL connection.
 
+
+.. danger::
+   When using Redis, make sure that you enable persistence (e.g. by setting ``save 1 1`` in the redis server configuration file). Otherwise all data will be lost after a restart!
+
 .. warning::
    The Redis password will be stored in plain text and can be viewed when re-running the setup.
 

internal/configuration/database/provider/redis/Redis.go

@@ -3,14 +3,14 @@ package redis
 import (
 	"errors"
 	"fmt"
-	"github.com/forceu/gokapi/internal/environment"
-	"github.com/forceu/gokapi/internal/helper"
-	"github.com/forceu/gokapi/internal/models"
-	redigo "github.com/gomodule/redigo/redis"
 	"os"
 	"strconv"
 	"strings"
 	"time"
+
+	"github.com/forceu/gokapi/internal/helper"
+	"github.com/forceu/gokapi/internal/models"
+	redigo "github.com/gomodule/redigo/redis"
 )
 
 // DatabaseProvider contains the database instance
@@ -47,6 +47,15 @@ func (p DatabaseProvider) init(config models.DbConnection) (DatabaseProvider, er
 	if err != nil {
 		return DatabaseProvider{}, err
 	}
+	isPersistenceEnabled, err := p.isPersistenceEnabled()
+	if err == nil {
+		if !isPersistenceEnabled {
+			fmt.Println("WARNING! Redis persistence is disabled. ALL DATA WILL BE LOST after a database restart.")
+		}
+	} else {
+		fmt.Println("Unable to check if Redis has persistence enabled.")
+	}
+
 	// If DB version is 0, the DB is new and therefore set version to latest one.
 	// Otherwise, Upgrade() would be called after loading
 	if p.GetDbVersion() == 0 {
@@ -55,6 +64,18 @@ func (p DatabaseProvider) init(config models.DbConnection) (DatabaseProvider, er
 	return p, nil
 }
 
+func (p DatabaseProvider) isPersistenceEnabled() (bool, error) {
+	output, err := redigo.Values(p.getConfigRaw("save"))
+	if err != nil {
+		return false, err
+	}
+	if len(output) < 2 {
+		return false, nil
+	}
+	saveVal, _ := redigo.String(output[1], nil)
+	return len(saveVal) > 0, nil
+}
+
 func getDialOptions(config models.DbConnection) []redigo.DialOption {
 	dialOptions := []redigo.DialOption{redigo.DialClientName("gokapi")}
 	if config.Username != "" {
@@ -211,6 +232,11 @@ func (p DatabaseProvider) getKeyRaw(id string) (any, error) {
 	return conn.Do("GET", p.dbPrefix+id)
 }
 
+func (p DatabaseProvider) getConfigRaw(id string) (any, error) {
+	conn := p.pool.Get()
+	defer conn.Close()
+	return conn.Do("CONFIG", "GET", id)
+}
 func (p DatabaseProvider) getKeyString(id string) (string, bool) {
 	result, err := redigo.String(p.getKeyRaw(id))
 	if result == "" {

internal/configuration/setup/templates/setup.tmpl

@@ -113,7 +113,7 @@
 
 {{ if not .IsInitialSetup }}
 				<p>
-					<span style="color:red"><b>Warning:</b> When changing database parameters, ensure you first migrate the database to the new location using <code>gokapi --migrate-database</code> before finalising the setup.</span>
+					<span style="color:red"><b>Warning:</b> When changing database parameters, ensure you first migrate the database to the new location using <code>gokapi migrate-database</code> before finalising the setup.</span>
 				</p><br>
 {{ end }}