|Philipp Häfelfinger 425f8870e3||7 months ago|
|.github/ISSUE_TEMPLATE||1 year ago|
|build||1 year ago|
|cmd/PiwigoDirectoryUploader||9 months ago|
|configs||9 months ago|
|internal||7 months ago|
|test||9 months ago|
|.drone.yml||1 year ago|
|.gitignore||9 months ago|
|LICENSE||1 year ago|
|README.md||9 months ago|
|go.mod||9 months ago|
|go.sum||9 months ago|
This tool mirrors the directory structure of the given root directory as albums and sub albums in Piwigo and uploads all images to the albums.
Currently, the uploader supports the following features
There are some features planned but not ready yet:
There are some external dependencies to build the application.
To get the latest version, you should
git clone https://git.haefelfinger.net/piwigo/PiwigoDirectoryUploader.git to
your local disk or into your local go source directory by using ``go get git.haefelfinger.net/piwigo/PiwigoDirectoryUploader`.
This repository supports gomodules, so the modules should be resolved automatically during build or test run. But just in case, here are the manual commands to install them. This is needed if you put this repo inside the GOPATH as this sets the module config to ignore.
To get all dependencies at once:
go get ./... go install github.com/golang/mock/mockgen
The installation of mockgen is required to use
go generate ./... to build the mocks.
You may install the dependencies manually with the following commands or just use the command under "GO modules" to get all dependencies.
go get github.com/sirupsen/logrus go get github.com/vharitonsky/iniflags
To build the mocks there are two go:generate dependencies. The mockgen dependency must be installed to make it work:
go get github.com/golang/mock/gomock go get github.com/golang/mock/mockgen go install github.com/golang/mock/mockgen
To rebuild the mocks you can simply use the following command:
go generate ./...
Build the main executable by using the following command. The binary gets the name
but can be renamed to your favorite application name.
go build cmd/PiwigoDirectoryUploader/PiwigoDirectoryUploader.go
To get a fully static linked executable, you can use the build script build-musl.sh under the build folder.
You need to have musl installed and musl-gcc in your environment available to make this work. Under Arch Linux
the package is
This static linked executable can be run in an absolute minimalistic linux image and without installing any dependencies or additional packages.
You get the following help information to the command line by using:
The following options are supported to run the application from the command line. You will find mor details on some commands below the usage list.
Usage of ./dist/PiwigoDirectoryUploader: -allowMissingConfig Don't terminate the app if the ini file cannot be read. -allowUnknownFlags Don't terminate the app if ini file contains unknown flags. -config string Path to ini config for using in go flags. May be relative to the current executable path. -configUpdateInterval duration Update interval for re-reading config file set via -config flag. Zero disables config file re-reading. -dirSuffixToSkip int Set the number of directories at the end of the filepath to remove to build the category (e.g. value of 1: /foo/png/img.png results in foo/img.png). -dumpflags Dumps values for all flags defined in the app into stdout in ini-compatible syntax and terminates the app. -extension value Supported file extensions. Flag can be specified multiple times. Uses jpg and png if omitted. -ignoreDir value Directories that should be ignored. Flag can be specified multiple times for more than one directory. -imagesRootPath string This is the images root path that should be mirrored to piwigo. -logLevel string The minimum log level required to write out a log message. (panic,fatal,error,warn,info,debug,trace) (default "info") -noUpload If set to true, the metadata gets prepared but the upload is not called and the application is exited with code 90 -parallelUploads int Set the number of images that get uploaded in parallel. (default 4) -piwigoPassword string This is password to the given username. -piwigoUrl string The root url without tailing slash to your piwigo installation. -piwigoUser string The username to use during sync. -removeImages If set to true, images scheduled to delete will be removed from the piwigo server. Be sure you want to delete images before enabling this flag. -sqliteDb string The connection string to the sql lite database file. (default "./localstate.db")
Set the number of directories at the end of the filepath to remove to build the category. This comes in handy if you have a directory structure similar to mine.
Here is an example:
. ├── 2019 | └── Event1 | └── jpg │ | ├── Image01.jpg │ | └── Image02.jpg | └── png │ | ├── Image01.png │ | └── Image02.png | └── raw │ ├── Image01.cr2 │ └── Image02.cr2 ├── 2020 | └── Event1 | | └── jpg │ | | ├── Image01.jpg │ | | └── Image02.jpg | | └── png │ | | ├── Image01.png │ | | └── Image02.png | | └── raw │ | ├── Image01.cr2 │ | └── Image02.cr2 | └── Event2 | └── jpg │ | ├── Image01.jpg │ | └── Image02.jpg | └── png │ | ├── Image01.png │ | └── Image02.png | └── raw │ ├── Image01.cr2 │ └── Image02.cr2
By default, the uploader generates the exact same entries as directory structure in Piwigo.
I do not want that the category in Piwigo contains the name
png if I upload all files from the
To fix this, you may set
1 to move the files one level up and change
2017/Event1 in Piwigo and forget about the
png folder name.
This flag contains the directory names that should be ignored during the directory walk.
You may use the flag multiple times to specify more than one value.
Taking the structure above, you can use this flag to ignore
raw folders from the scan.
This can speed up the directory walking and prevent wrong results.
Set the number of images that get uploaded in parallel. The default value of this setting is four. How many concurrent uploads will work for you depend on the performance of the server and your client host. The server may be the problem for almost all users. Do not set this option to a value that stresses your server too much or you might see some issues on the user side of the gallery.
Specify the file extensions that should be used to look up images.
By default, the system looks for
It is also possible to use a configuration file to save the settings to be used with multiple piwigo instances. To use configuration files, just copy the default one and edit the parameters to your wish.
cp ./configs/defaultConfig.ini ./localConfig.ini nano ./localConfig.ini
Finally, you may run the application using the following example command.
If you mess up the local database for some reason, you may just delete it and let the uploader regenerate the content. The only thing you might lose in this situation is the track of the files that should be deleted during next sync as this information is build upon existing records of the local database.