Skip to content

Commit

Permalink
Merge pull request #19 from erichobson/paperless
Browse files Browse the repository at this point in the history
Added Paperless-ngx
  • Loading branch information
azukaar authored Aug 7, 2023
2 parents 8d01523 + fd536fa commit b5727a5
Show file tree
Hide file tree
Showing 5 changed files with 205 additions and 0 deletions.
196 changes: 196 additions & 0 deletions servapps/Paperless-ngx/cosmos-compose.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
{
"cosmos-installer": {
"form": [
{
"type": "info",
"label": "PostgreSQL is used as the database server. Apache Tika and Gotenberg servers are started with paperless and paperless is configured to use these services. These provide support for consuming Office documents (Word, Excel, Power Point and their LibreOffice counterparts."
},
{
"name": "username",
"label": "Would you like to change the admin username? (Default: admin)",
"initialValue": "admin",
"type": "text"
},
{
"name": "password",
"label": "Would you like to change the admin password? (Default: password)",
"initialValue": "password",
"type": "password"
},
{
"name": "exportDirectory",
"label": "What is the path to the export directory?",
"initialValue": "{DefaultDataPath}/Paperless-export",
"type": "text"
},
{
"name": "consumeDirectory",
"label": "What is the path to the consume directory?",
"initialValue": "{DefaultDataPath}/Paperless-consume",
"type": "text"
},
{
"name": "adminOnly",
"label": "Do you want to make this service admin only?",
"initialValue": false,
"type": "checkbox"
}
]
},
"minVersion": "0.9.16",
"services": {
"{ServiceName}-broker": {
"image": "docker.io/library/redis:7",
"container_name": "{ServiceName}-broker",
"restart": "unless-stopped",
"volumes": [
{
"source": "{ServiceName}-redisdata",
"target": "/data",
"type": "volume"
}
],
"labels": {
"cosmos-force-network-secured": "true",
"cosmos-auto-update": "true",
"cosmos-icon": "https://azukaar.github.io/cosmos-servapps-official/servapps/Paperless-ngx/icon.png"
},
"networks": {
"{ServiceName}-network": {}
}
},

"{ServiceName}-db": {
"image": "docker.io/library/postgres:15",
"container_name": "{ServiceName}-db",
"restart": "unless-stopped",
"volumes": [
{
"source": "{ServiceName}-pgdata",
"target": "/var/lib/postgresql/data",
"type": "volume"
}
],
"environment": [
"POSTGRES_DB=paperless",
"POSTGRES_USER=paperless",
"POSTGRES_PASSWORD={Passwords.0}"
],
"labels": {
"cosmos-force-network-secured": "true",
"cosmos-auto-update": "true",
"cosmos-icon": "https://azukaar.github.io/cosmos-servapps-official/servapps/Paperless-ngx/icon.png"
},
"networks": {
"{ServiceName}-network": {}
}
},

"{ServiceName}": {
"image": "ghcr.io/paperless-ngx/paperless-ngx:latest",
"restart": "unless-stopped",
"depends_on": [
"{ServiceName}-db",
"{ServiceName}-broker",
"{ServiceName}-gotenberg",
"{ServiceName}-tika"
],
"volumes": [
{
"source": "{ServiceName}-data",
"target": "/usr/src/paperless/data",
"type": "volume"
},
{
"source": "{ServiceName}-media",
"target": "/usr/src/paperless/media",
"type": "volume"
},
{
"source": "{Context.exportDirectory}",
"target": "/usr/src/paperless/export",
"type": "bind"
},
{
"source": "{Context.consumeDirectory}",
"target": "/usr/src/paperless/consume",
"type": "bind"
}
],
"environment": [
"PAPERLESS_REDIS=redis://{ServiceName}-broker:6379",
"PAPERLESS_DBHOST={ServiceName}-db",
"PAPERLESS_DBPASS={Passwords.0}",
"PAPERLESS_TIKA_ENABLED=1",
"PAPERLESS_TIKA_GOTENBERG_ENDPOINT=http://{ServiceName}-gotenberg:3000",
"PAPERLESS_TIKA_ENDPOINT=http://{ServiceName}-tika:9998",
"USERMAP_UID=1000",
"USERMAP_GID=1000",
"PAPERLESS_ADMIN_USER={Context.username}",
"PAPERLESS_ADMIN_PASSWORD={Context.password}",
"PAPERLESS_URL=https://{Hostnames.{StaticServiceName}.{StaticServiceName}.host}"
],
"labels": {
"cosmos-force-network-secured": "true",
"cosmos-auto-update": "true",
"cosmos-icon": "https://azukaar.github.io/cosmos-servapps-official/servapps/Paperless-ngx/icon.png"
},
"container_name": "{ServiceName}",
"networks": {
"{ServiceName}-network": {}
},
"routes": [
{
"name": "{ServiceName}",
"description": "Expose {ServiceName} to the web",
"useHost": true,
"target": "http://{ServiceName}:8000",
"mode": "SERVAPP",
"Timeout": 14400000,
"ThrottlePerMinute": 12000,
"BlockCommonBots": true,
"SmartShield": {
"Enabled": true
},
"AuthEnabled": true
{if Context.adminOnly}
, "AuthAdmin": true
{/if}
}
]
},

"{ServiceName}-gotenberg": {
"image": "docker.io/gotenberg/gotenberg:7.8",
"container_name": "{ServiceName}-gotenberg",
"restart": "unless-stopped",
"labels": {
"cosmos-force-network-secured": "true",
"cosmos-auto-update": "true",
"cosmos-icon": "https://azukaar.github.io/cosmos-servapps-official/servapps/Paperless-ngx/icon.png"
},
"networks": {
"{ServiceName}-network": {}
}
},

"{ServiceName}-tika": {
"image": "ghcr.io/paperless-ngx/tika:latest",
"container_name": "{ServiceName}-tika",
"restart": "unless-stopped",
"labels": {
"cosmos-force-network-secured": "true",
"cosmos-auto-update": "true",
"cosmos-icon": "https://azukaar.github.io/cosmos-servapps-official/servapps/Paperless-ngx/icon.png"
},
"networks": {
"{ServiceName}-network": {}
}
}
},

"networks": {
"{ServiceName}-network": {
}
}
}
9 changes: 9 additions & 0 deletions servapps/Paperless-ngx/description.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "Paperless-ngx",
"longDescription": "<p>Paperless-ngx is a community-supported open-source document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.</p><p>This version of Paperless-ngx is configured using PostgreSQL as the database server, as well as Apache, Tika, and Gotenberg servers to provide support for consuming Office documents (Word, Excel, Power Point and their LibreOffice counterparts.</p>",
"description": "Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.",
"tags": ["document", "management", "organization", "archive", "collection", "web interface", "paper", "docker"],
"repository": "https://github.com/paperless-ngx/paperless-ngx",
"image": "https://ghcr.io/paperless-ngx/paperless-ngx",
"supported_architectures": ["amd64", "arm64"]
}
Binary file added servapps/Paperless-ngx/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added servapps/Paperless-ngx/screenshots/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added servapps/Paperless-ngx/screenshots/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b5727a5

Please sign in to comment.