README.md (2041B)
1 # Install agate in a docker container 2 (these instructions assume you use linux and have some experience with both docker and the command line) 3 ## obtain the source code 4 5 There are currently no container images online so you have to build the image yourself before you can use it. 6 There are two options available for this: downloading a release or cloning the repository with `git`. 7 I will explain both methods but if you're unsure which method to use, I would recommend the release for new comers because it's probably more tested so you'll encounter less problems. 8 9 ### downloading the release tarball 10 11 Download the tarball. Go to [https://github.com/mbrubeck/agate/releases/latest](https://github.com/mbrubeck/agate/releases/latest), and copy the url of the source code tarball. 12 13 ``` 14 wget URL 15 ``` 16 17 Then unpack the tarball and remove it afterwards: 18 ``` 19 tar -xzf tarball.tar.gz 20 rm tarball.tar.gz 21 ``` 22 23 ### clone the repository with git 24 25 I assume you have git already installed. If not, please search on how to do it in the internet. 26 27 ``` 28 git clone https://github.com/mbrubeck/agate 29 cd agate 30 ``` 31 32 ## build the image 33 Enter the `tools/docker` directory: 34 35 ``` 36 cd tools/docker 37 ``` 38 And now build the docker image: 39 40 ``` 41 docker build -t agate . 42 ``` 43 This process will take a few minutes because all the rust modules have to be compiled from source. 44 45 ## start the docker container 46 47 ``` 48 docker run -t -d --name agate -p 1965:1965 -v /var/www/gmi:/gmi -v /var/www/gmi/.certificates:/app/.certificates -e HOSTNAME=example.org -e LANG=en-US agate:latest 49 ``` 50 51 You have to replace `/var/www/gmi/` with the folder where you'd like to have gemtext files and `/var/www/gmi/.certificates/` with the folder where you'd like to have your certificates stored. You also have to have to replace `example.org` with your domain name and if plan to speak in a different language than english in your gemini space than you should replace `en-US` with your countries language code (for example de-DE or fr-CA). 52 53 ## That's it! Now have agate running in a docker container!