**update** README.md

**update** examples/linkding/docker-compose.yml
**update** examples/wallabag/docker-compose.yml
This commit is contained in:
Aytac Kirmizi 2023-02-02 16:39:05 +01:00
parent 4c942d6122
commit fdcfba3c90
5 changed files with 58 additions and 26 deletions

View File

@ -35,12 +35,12 @@ Environment variables for the linkding worker.
| Linkding__Key | text | The linkding application key | [Instructions](https://github.com/sissbruecker/linkding/blob/master/docs/API.md) |
## Configuration
The following explains the configuration options.
The following explains the configuration options. The Configuration file must be mapped to **/app/data/config.yml**
### WallabagSync
The configuration is optional. In the configuration (**YAML File**) rules can be defined in regex to exclude certain domains from sync.
Exampel:
````yaml
```yaml
excludedDomains:
- name: youtube
pattern: 'https://[[a-zA-Z0-9]+\.]?(youtube)\.com(?:/.*)?'
@ -48,7 +48,7 @@ excludedDomains:
pattern: 'https://[[a-zA-Z0-9]+\.]?(ebay)\.(com|de|fr)(?:/.*)?'
- name: amazon
pattern: 'https://[[a-zA-Z0-9]+\.]?(amazon)\.(com|de|fr)(?:/.*)?'
````
```
With this configuration every matching bookmark from linkding will be excluded from the sync.
### LinkdingUpdater
@ -57,7 +57,7 @@ The configuration is optional. In the configuration (**YAML File**) rules can be
If operated without a configuration file, only the year of the tag is added (currently).
Example:
````yaml
```yaml
urlTagMapping:
- name: microsoft_azure
url: https://github.com/azure
@ -97,30 +97,59 @@ taggingRule:
- name: github.io
pattern: https://([a-zA-Z0-9]+)\.(github)\.io[/]?([a-zA-Z0-9\-\+_]+)(?:/)?([a-zA-Z0-9\-\+_]+)?(?:/.*)?
replace: $1,$2,$3
````
```
#### urlTagMapping
If the bookmark should match one - or more - of the urlTagMappings, then value of name is added as tag to this bookmark.
Example:
https://github.com/azure/something will be tagged with microsoft_azure
#### taggingRule
Dynamic tags can be assigned to the bookmarks on the basis of the URL using regular expression. If one of the patterns matches, the values of the groups are added to the bookmark as a tag.
Example:
Here is an example using a reddit bookmark.
Url:
- ht<span>tps://ww</span>w.reddit.com/r/selfhosted/comments/yzq6qp/running_a_mostly_sbcbased_nomad_cluster_in_my/?utm_source=share&utm_medium=android_app&utm_name=androidcss&utm_term=2&utm_content=share_button
Pattern:
- https://(?:www\.)?(reddit)\.com(?:/r/)?([a-zA-Z0-9\-\+_]+)?(?:/.*)?
Matches:
- ht<span>tps://ww</span>w.<span style="color:red">reddit</span>.com/r/<span style="color:red">selfhosted</span>/comments/yzq6qp/running_a_mostly_sbcbased_nomad_cluster_in_my/?utm_source=share&utm_medium=android_app&utm_name=androidcss&utm_term=2&utm_content=share_button
if you would change the pattern to the following.
Pattern:
- https://(?:www\.)?(reddit)\.com(?:/)?(r/[a-zA-Z0-9\-\+_]+)?(?:/.*)?
then the following would match.
- ht<span>tps://ww</span>w.<span style="color:red">reddit</span>.com/<span style="color:red">r/selfhosted</span>/comments/yzq6qp/running_a_mostly_sbcbased_nomad_cluster_in_my/?utm_source=share&utm_medium=android_app&utm_name=androidcss&utm_term=2&utm_content=share_button
## Docker Run
```
docker run --rm -it --env-file .env -v <path>/config.yml:/app/data/config.yml linkdingsync/wallabag:latest
```bash
docker run --rm -it --env-file .env -v <path>/config.yml:/app/data/config.yml ghcr.io/spaytac/linkding-updater:latest
```
You can also
```bash
docker run --rm -it --env-file .env -v <path>/config.yml:/app/data/config.yml ghcr.io/spaytac/wallabag-sync:latest
```
## Docker Compose
You can find [examples](./examples/) in the examples folder..
- [Wallabag Example](./examples/wallabag/)
- [WallabagSync Example](./examples/wallabag/)
- [LinkdingUpdater Example](./examples/linkding/)
## Build Docker Image
## Build Docker Images
### LinkdingUpdater
```
docker build -t linkdingsync/linkdingupdater:latest -f .\Dockerfile_Linkding .
docker build -t linkdingsync/linkding-updater:latest -f .\Dockerfile_Linkding .
```
### WallabagSync
```
docker build -t linkdingsync/wallabag:latest -f .\Dockerfile_Wallabag .
docker build -t linkdingsync/wallabag-sync:latest -f .\Dockerfile_Wallabag .
```

View File

@ -2,9 +2,9 @@ version: '3.9'
services:
linkdingupdater:
image: linkdingsync/linkdingupdater:latest
image: ghcr.io/spaytac/linkding-updater:latest
volumes:
- ./config.yml:/data/config.yml
- ./config.yml:/app/data/config.yml
# env_file:
# - .env
environment:

View File

@ -2,9 +2,9 @@ version: '3.9'
services:
wallabagsync:
image: linkdingsync/wallabag:latest
image: ghcr.io/spaytac/wallabag-sync:latest
volumes:
- ./config.yml:/data/config.yml
- ./config.yml:/app/data/config.yml
# env_file:
# - .env
environment:

View File

@ -26,6 +26,9 @@ namespace Wallabag.Handler
{
var settings = SettingsService.Settings;
// var settingsString = JsonSerializer.Serialize(settings);
// logger.LogInformation($"settings: {settingsString}");
var tagName = configuration.GetValue<string>("Worker:SyncTag");
linkdingBookmarks =