# Gramps WebAPI installation on Synology NAS - using docker

**URL:** https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890
**Category:** Gramps Web
**Tags:** websolutions
**Created:** [October 10, 2021, 8:18am UTC](https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890 "2021-10-10T08:18:56Z")
**Posts on this page:** 9
**Page:** 1

<div class="post-metadata">

### Author: ![vivian](https://avatars.discourse-cdn.com/v4/letter/v/3e96dc/32.png) [@vivian](https://gramps.discourse.group/u/vivian)
#### Post date: [October 10, 2021, 8:18am UTC](https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890/1 "2021-10-10T08:18:56Z")

</div>

So some time ago, I had come here asking for [help running it on a VM on Synology](https://gramps.discourse.group/t/gramps-installation-on-a-vm-on-synology-nas/1634). However, after rightly being redirected to docker.  
I promised to create a video tutorial but I chickened out and wrote the instructions with screenshots.  
@emyoulation and @DavidMStraub hopefully I have not disappointed you with the delay and going by a writeup instead of a video.

Link to the article: [How to Install Gramps Web API on a Synology NAS | by Vivian Lobo | Sep, 2021 | Medium](https://vivianlobo.medium.com/how-to-install-gramps-web-api-on-a-synology-nas-1cba93a56ca2)

If it is worth, then may be a link within the wiki. (Excuse the shameless plug)  
I will write up some more with other options to install on Synology.

---

<div class="post-metadata">

### Author: ![DavidMStraub](https://yyz2.discourse-cdn.com/free1/user_avatar/gramps.discourse.group/davidmstraub/32/7_2.png) [@DavidMStraub](https://gramps.discourse.group/u/DavidMStraub)
#### Post date: [October 10, 2021, 8:44am UTC](https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890/2 "2021-10-10T08:44:48Z")

</div>

Hi @vivian, thanks, that’s awesome! Since the original post, we have set up a new documentation site at [Introduction - Gramps Web API](https://gramps-project.github.io/gramps-webapi/) which is populated from the Markdown files in the `docs` folder. Feel free to add a link in a PR!

By the way, yesterday, I have opened a [new pull request](https://github.com/gramps-project/gramps-webapi/pull/229) with some (backwards compatible) changes to the configuration system and the docker image. This will simplify the docker-based deployment, getting rid of two of the steps in [this procedure](https://gramps-project.github.io/gramps-webapi/Deployment/).

---

<div class="post-metadata">

### Author: ![vivian](https://avatars.discourse-cdn.com/v4/letter/v/3e96dc/32.png) [@vivian](https://gramps.discourse.group/u/vivian)
#### Post date: [October 10, 2021, 9:04am UTC](https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890/3 "2021-10-10T09:04:12Z")

</div>

Oh woah… the new update looks awesome. I will update the article accordingly. I did notice the new doc site and it is so much easier and better looking now.  
I have also made sure I have linked to the new doc site and will issue a PR

Edit: I Will request a PR after your changes have been merged.

---

<div class="post-metadata">

### Author: ![emyoulation](https://yyz2.discourse-cdn.com/free1/user_avatar/gramps.discourse.group/emyoulation/32/67_2.png) [@emyoulation](https://gramps.discourse.group/u/emyoulation)
#### Post date: [October 10, 2021, 2:23pm UTC](https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890/4 "2021-10-10T14:23:46Z")

</div>

> [@vivian](#):
>
> @emyoulation and @DavidMStraub hopefully I have not disappointed you with the delay and going by a writeup instead of a video.

Personally, I prefer articles over videos when actually working a task. (Although videos can create more confidence for novices trying to determine whether a task is within their skill set and degree of commitment.)

Writing good articles tends to force me to explore a process more exhaustively. It benefits me as a user because I learn the subject more thoroughly in order to write about it. I hope you’ve found this benefit too!

As an open-source all-volunteer project, I don’t think there is any expectation of specific commitments or timelines. People contribute effort as it fits into their life. And any contribution is a blessing.

There was a person [posting to Matrix](https://matrix.to/#/!gqULXnRVQbsasvDMCZ:matrix.org/$ijjEFmuJb67AeIBd3bnse5eMK7JMCZ7d4VbL0CbbGc4?via=matrix.org&via=libera.chat) looking to get Gramps going in Russian on a Synology NAS. The moderator was unfamiliar with modern NAS products that are more than a network-visible file folder.

I posted a link in that thread to your article. Dunno if that notifies the user who originally asked but who has signed out.

---

<div class="post-metadata">

### Author: ![vivian](https://avatars.discourse-cdn.com/v4/letter/v/3e96dc/32.png) [@vivian](https://gramps.discourse.group/u/vivian)
#### Post date: [October 10, 2021, 2:52pm UTC](https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890/5 "2021-10-10T14:52:40Z")

</div>

> [@emyoulation](#):
>
> Writing good articles tends to force me to explore a process more exhaustively. It benefits me as a user because I learn the subject more thoroughly in order to write about it.

I totally agree on this point. I did write it at least 4-5 times and made sure every screenshot matched and so on. I am so thorough now that I can write it with my eyes closed.  
I am waiting for David to merge his PR and then I will be able to make the screenshot changes.  
Portainer is great but I will also do a write up of directly using the docker compose command.

Thanks again for the encouragement.

---

<div class="post-metadata">

### Author: ![vivian](https://avatars.discourse-cdn.com/v4/letter/v/3e96dc/32.png) [@vivian](https://gramps.discourse.group/u/vivian)
#### Post date: [October 10, 2021, 7:15pm UTC](https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890/6 "2021-10-10T19:15:04Z")

</div>

Just realised the front end project David has.  
Woah that is a pain to run too on Synology, time for another article if I and when I overcome the pain.

---

<div class="post-metadata">

### Author: ![alexsunny123](https://avatars.discourse-cdn.com/v4/letter/a/51bf81/32.png) [@alexsunny123](https://gramps.discourse.group/u/alexsunny123)
#### Post date: [December 23, 2021, 12:57pm UTC](https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890/7 "2021-12-23T12:57:58Z")

</div>

thanks for the awesome information.

---

<div class="post-metadata">

### Author: ![alexsunny123](https://avatars.discourse-cdn.com/v4/letter/a/51bf81/32.png) [@alexsunny123](https://gramps.discourse.group/u/alexsunny123)
#### Post date: [October 31, 2022, 9:52am UTC](https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890/8 "2022-10-31T09:52:51Z")

</div>

> [@alexsunny123](#):
>
> thanks for the awesome information.  
> [.](https://ometv.onl)[.](https://chatroulette.top)

thanks my issue has been fixed.

---

<div class="post-metadata">

### Author: ![metadata](https://avatars.discourse-cdn.com/v4/letter/m/e36b37/32.png) [@metadata](https://gramps.discourse.group/u/metadata)
#### Post date: [December 14, 2022, 2:50am UTC](https://gramps.discourse.group/t/gramps-webapi-installation-on-synology-nas-using-docker/1890/9 "2022-12-14T02:50:29Z")

</div>

Being new to Docker and just having installed a Docker Desktop on a Win 11 PC to get to know Docker better, I am curious whether it might be possible to install this code and how I would go about it if it is possible?
