Transform Your Document Chaos with Paperless: A Self-Hosting Guide with Docker

here's a scenario you have a whole binder or whatever full of documents insurance documents or whatever important documents that you keep in track you can either store them via paper or everything's going a lot more digital now but even when you've got a digital saved in emails or whatever you can't really search for that specific document with that specific wording so that's where today's video comes in and we will cover and Tackle this issue right hello everyone in this video we are looking at paperless and we are going to solve that issue of when you just have documents everywhere emails physical and you just want to track them and you actually want to be able to track the words in them you know actually make the the words and the contents within the document searchable that's where paperless comes in and I'm going to tell you how you can get it hosted yourself and get it all up and running so first let's just do a bit of an overview of what it is and how it solves that problem so what we're looking at here is just our simple dashboard I've pretty much just got it all up and running and we'll go on to the specifics in a second this is just more for the ones that just just want to understand quickly on how it works so let's say we have a document and on the right hand side here under upload new documents I can upload a document to paper list so let's do that so I have a document here that I'm just uploading right now and you can see it's just processing that document getting it ready to get uploaded generating a thumbnail for it and it's done so what we can do is I can click Open document and so this is just a template document nothing official of course I don't want to put any of my actual documents in the video but this is just putting it here for an example so as you can see here we've got some some text and everything here and in the left hand side we can give it some proper details so you could be like all you know give it a something that actually means something to you so software documentation how about that that will do and then you if you want you can put serial numbers the dates that you put it in uh the document type you can add all these things I'll go into specifics later but if we click content here you see everything think in the document is now an actual searchable uh wording format that we can search on so if I click uh save right and now let's look for a specific word in here looks look for um ISO right so ISO is like a certain uh certification standard so if we come here and let's say someone was talking about ISO and what documents we had referring to that for whatever reason at the very top what we could do is Click search documents put I o in there right enter there we go see it knows that ISO is in that document and it's going oh yep here it is for you and there it is here and we can download it if we wanted to or anything like that um and then that is paperless so let's get into the more specifics on how we can get this up and running and all of that good stuff so let's get into it so as always uh this is the paperless official website I will leave this in the description below because they actually have a demo here so you can actually have a play around yourself before you go ahead and install it uh but yeah this will be in the description if you want to get more into it I'm not going to cover every single aspect of their website here but it's here if you want it go check it out but the main place we want to be and a link to this as well will be in the description is this specific location in their GitHub repository for the paperless uh engine x uh in the in that repository what we're doing is we're going to be deploying this via Docker like we always do and there's some two key files that they've provided for us which is the docker uh compose file and also an environment file so we will just use two of those the ones that we want that I would suggest to use uh if you're following this video is the postgress one so using the postgress as the database back end Dove also suggested that as well uh it's on their official documentation where they say uh to use the postgis now apparently if you are going to use one of these composed files and you are going with the post if you're working with office documents um use the one that ends with Tika t i k a right so this is real straightforward and easy because if you've watched the other videos where we just copy the docker compos contents and we make a file that's all we're doing here so let's get into it so what we're going to need to do is have access to our server where we're going to be deploying this so this is my Electron Cloud Server this is where I will be running paperless and if you are curious I lay out all of my Docker containers via folders so I have like a folder called Docker and within there is a folder for all of my containers and it will contain all of their files and composed files and everything that they need so feel free to copy that sort of uh way of managing your containers and their files so if we change directory I've made a folder called paperless right so if we go on that and you can see that I have two files a Docker composed. EnV and a Docker uh just compose yl so what we're going to want to do is go back to the GitHub page which is here and this post gr one here with the the tika on the end t i Ka I don't know if that's been pronounced right but oh well and all we want to do is on the right hand side here there's just the copy raw file so we'll just copy that go back to our server and then you just want to make that file right so just a nano and then Docker compose so hyphen compose do yaml and and this will make a file for you now I've already got this file it exists but and for the sake of this video I'm going to remove all of these so I'll so I can start from scratch as well and show you so let's remove that one and let's remove that one so again Nano Docker hyen compose if I can spell yam and we paste that contents in that we just copied from the GitHub right and this is the compose the there's also the environment to go so we'll just have a look through this and read cuz there's some important information here so at the top theyve just got a ni little explanation of what's going on here and how the folders work and also what port it runs on so you can see here that paperless will be running on Port 8000 but I'll show you how you can change that if you like and then it's talking about um how it's setting up a database and all of that stuff here so it's saying that post SQL is used as the database server because that's the one we've grabbed and then it's also got Apache Tika and gothenberg servers it started with paperless um it's all configured and it says here these will provide support for consuming Office document word excel PowerPoint all of that good stuff so if this is all a bit confusing in a nutshell all the the additional using that tiker um is allowing us it's allowing support for word and all of that without it you wouldn't have uh office support so that's all that's doing and you can see here that they've just got another couple of um steps that is talking about is you know you can run the docker compos pool R run the docker compos run and running this web server creates super user so what this does here this is a step once we've actually got it up and running uh we can add a user again I'm going to walk you through all of this I'm just kind of covering what's in this file cuz it's good to know and then we've got the actual core contents of the compost file itself so we've got a Rus container there we've got a database which is our postgress uh database and you can see here that there's a username and password and all of that stuff now when it comes to the password if you're making this public in production and everything like that make sure you're changing that password of course we've got the paperless web server itself and you can see here that it's depending on all the other services to be stood up before it runs itself and then this is the port that we will connect to paperless on so it will be Port 8,000 now if you're already using Port 8000 feel free to change that to whatever you like I'm going to change that to $89 95 in my example so this here is the health check so this is just going to check that it's up and running on it can actually reach itself and we don't need to change this because this is running inside the container and the container itself is running paperless on 8,000 so you're all good there and then we've got all the volumes um and you can see that it's relying on that environment file that we have right so it's it's expecting that file and I'll show you that in a second a lot of the stuff you don't need to actually worry about changing I'm just kind of helping you exp understand why things are here um and then you've got the Gutenberg stuff and you've also got the tika container as well for that support for office documentation so that's it we don't really need to change anything I only change the port so let's save that and exit on over there and then we had that one other file right so at the moment we've got the dock and compos file so jumping back to the GitHub we've got the docker compose Dov file same sort of process we just need to copy this this right easy and go back to our server and we make another file so Nano Docker compose Dov hit enter paste and now with this one here everything is pretty much commented out so nothing's actually been used here but what we're wanting is to actually enable a few things you can see here it's saying the uid and the g of the user to run paperless in the container set this U ID and GID on the host so that you have right access to the consumption directory so what this is saying is your user your local user on your server that's running this will have access to the directories that are being made here so by default my user is um ID 1000 so a lot of this will just work uh for you but you can always confirm your your ID for your user um via a command which I'll show you in a second um but yeah so we can we can just uncomment those out and a lot of the other stuff we can kind of just leave commented out to be honest um so we've got here so if you are actually planning on making your paper lless public uh like actually on the internet and accessible this is where You' tell paperless what the domain would be uh of your paperless so even if you're using something like Cloud flare to expose it you still need to supply that domain name here okay so that's where you'll do it and then the same with the key make sure to change this if you're making it accessible on the web and then also setting your time zone um for paperless so I'm going to I want to set my time zone and the rest I'm leaving as it is save that exit out okay so let's do a bit of a recap really quickly we've made two files the docker compos EnV and the docker compose doyl all of these have just been copied and pasted from the GitHub here and again a link to this will be in the description so once you've got those two files all we need to do now is do Docker compose up hyph D and hit enter and it's going to create everything for us and now we should have our container up and running so if I just do a Docker PS hyen a and let's search for paperless there we go so we can see that we have uh 1 2 3 four five containers that are part of the stack for paperless right so all of these make up that service all these containers make up the service for paperless and we can see that our health uh check that was there is up uh it's starting at the moment so if we search again it's still starting and now we know it says healthy now we know our container is up our paperless is up and we should be able to access it on Port 8095 so let's let's try connect to it so at the top here I can search via the uh domain name I've just SE a local main name for my server which is electron cloud but I could also connect to the IP address uh so just the IP address of your server and you can find that just by doing IP addr enter I have a lot so let's search for 192 192 there we go so this 119 is the IP address of my server so I can put HTTP for/ for/ paste that in and Port 8095 H enter there we go but remember we can't we don't have a user we can't connect now in that compos file it told us how we can set up our user right so looking in that compos file we can see it's saying hey look run this command here and this will set up your super user for you so let's copy that and hit enter run that and it's just going to do some checks and now it's going cool at the bottom hey what's the username and let's just go Tik tox enter email address I'm not going to supply one I'll just leave it blank pass password let's set a password there we go and it says at the bottom super user uh created successfully so we can go back just give it a bit of a refresh so put in uh Tik tox as user and we'll put in the password enter there we go we have paperless up and running um just like that so again we just needed those couple of files uh make the changes that we needed like the port and stuff like that and if you're going to make it public that's where you specify the domain name and all of that good stuff Dock and compose up just following the commands I did and you will be here but if you got stuck at any point of that make sure to join my Discord or uh just ask below I'm pretty active with answering comments so I'm more than happy to help out if you do get stuck uh cuz it was a bit there um but yeah we're in paperless now so this is where we can really start just to have a play around so you see here they actually have a bit of like a start the tour so it will actually show you around so if we click here it's saying you know how the dashboard can be used um and then it's showing you you can just drag and drop documents into this section here on the right hand side and then it's actually just going to take us through everything uh the document list um how you can do filtering all of that good stuff I'll leave that to you though to have a play around to to figure all of that stuff out as well but let's just upload another document and let's just have a a bit more of a look around all of this stuff I'm uploading a document which was that same document that was just that template document and we'll let that go up so rather than clicking on Open document what I'm actually going to do is just refresh the page and then go to documents and now you see it pop up right and we've got a couple of things here so we've got the edit section we've got if you hover over this this is just like a preview eye right so you can just quickly have get an idea of what's going on and we can just download it locally as well but let's hit edit and you can see here again we can set the title but we can actually do some other cool stuff we can set permissions so you can actually have multiple users being able to connect to this so if you're just running this at home or even maybe it's a work thing you can set up users on who can actually access this you can have groups um and set up all of the user access and stuff like that as well and all of that user and group stuff can be if you click on the top right hand corner and go to settings you'll see that we've got a few things here so under user and groups this is where we can add more people or we can add groups you know if it's a work thing you can have departments and all that good Stu stuff um and you know you got some other sections here uh as well so you can setting up notifications all of that good stuff that you want to configure and and all documents can be you know stored via tag so you can check them that way um I think you get the idea so that's paperless uh or paperless engine X I hope that kind of allowed you to understand how you can use this and the benefit uh I review a lot of things and I play around and make videos on a lot of tools but I think this one in particular is actually something I'm going to have around for the long term just being able to manage you know scan and documents take photos on my phone it doesn't matter how you want to go about it you can just upload them here and then providing that clear enough text you should be able to search all the text within the document uh yeah this one's here to stay I think but anyway thank you so much for watching uh I really appreciate all the support lately make again make sure to check out the Discord um members YouTube members get one-on-one support with me uh in the Discord if you need it and then you also just got YouTube comments as well below uh more than happy to help if you need it uh but yeah thank you so much for watching and I'll see you in the next one [Music] byebye

Channel: Techdox

Views: 82,865

Keywords: docker, paperless-ngx, paperless-ngx docker, papermerge on docker, how to install papermerge docker, how to install papermerge on docker, install papermerge on docker, docker tutorial, how to install papermerge on openmediavault and docker, paperless ngx docker, docker compose, paperless-ngx setup, selfhosted, paperless-ng, paperless-ngx tutorial, how to install filerun on docker, how to install filerun in docker, install filerun on docker, best docker containers

Id: uT9Q5WdBGos

Length: 16min 58sec (1018 seconds)

Published: Sun Nov 26 2023