Skip to content

Commit 8d5cece

Browse files
Update readme.md
1 parent fc595dd commit 8d5cece

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

readme.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,24 +64,41 @@ Many Plugins have already been created for GoPage and are available by default a
6464
* Exaggerator Theme: Exaggerator Theme... Just Colourful.
6565
* AQI Current: Get Air Quality Information at a glance. Via AirNow.gov.
6666
* Self Hosted Icons: Get self Hosted High Quality Icons alongside their links.
67+
* Dev Service Icons: Devicons Wrapper for GoPage Link Items.
6768

6869
## Installation
6970

7071
### Docker
7172

7273
The installation for Docker should be universal for Linux, and Windows, taking only a few commands.
7374

74-
* First just download the Container
75-
* And run it using whatever Port you prefer, giving a name if you'd like, optionally setting the language.
75+
* First download the Docker Image.
76+
````(bash)
77+
docker pull ghcr.io/confused-techie/gopage:0.5.1
78+
````
79+
80+
* Then you will need to create a Named Docker Volume. This allows data to persist during updates.
81+
* Saving all your Link Items and their associated data.
82+
* Installed Plugins, and currently available Plugins. (But the 'Update Available Plugins' Button on the Plugin Repo will successfully update the available Plugins)
83+
* User Settings: Background Image, Header Plugins.
7684

7785
````(bash)
78-
docker pull ghcr.io/confused-techie/gopage:0.5
86+
docker volume create --name GoPageV
87+
````
88+
89+
* Finally with the Named Docker Volume created, and Image downloaded, we can run the Image.
7990

80-
docker run -p 7070:8080 --name GoPageServer ghcr.io/confused-techie/gopage:0.5
91+
````(bash)
92+
docker run -it -p 7070:8080 --name GoPage -v GoPageV:/app/data ghcr.io/confused-techie/gopage:0.5.1
8193
````
8294

83-
* Please keep in mind the **7070** shown here can be whatever port you want the Docker Container Exposed on. Whereas **8080** is the default port the GoPage Server will listen to within the container.
95+
When running the container, the above is all that's required, but there are many more options that can be set during this process.
8496

97+
And for testing purposes the Named Volume can be excluded but your data will not persist updates or removal of the Container.
98+
99+
* `-v GoPageV:/app/data` The Named Volume here should be whatever you created yours as during `docker volume create --name --`
100+
* `-it` Ensures to detach the shell allowing you to retain control of the TTY shell easily. Since in some circumstances SIGTERM may not be passed appropriately to the right context.
101+
* Please keep in mind the **7070** shown here can be whatever port you want the Docker Container Exposed on. Whereas **8080** is the default port the GoPage Server will listen to within the container.
85102
* GoPage supports additional variables that can be set. [Please refer to the documentation](docs/docker-environmentVariables.md).
86103

87104

0 commit comments

Comments
 (0)