From 32f267051d03527af482b37c6716e1e427b9d719 Mon Sep 17 00:00:00 2001 From: Kroese Date: Sun, 26 Mar 2023 21:21:13 +0200 Subject: [PATCH] Update readme.md --- readme.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/readme.md b/readme.md index e811b83..3921859 100644 --- a/readme.md +++ b/readme.md @@ -1,11 +1,30 @@ # virtual-dsm -[![Test](https://github.com/kroese/virtual-dsm/actions/workflows/test.yaml/badge.svg)](https://github.com/kroese/virtual-dsm/actions/workflows/test.yaml) +[![Build Status]][builds] +[![Test]][test] +[![gh_last_release_svg]][gh_last_release_url] +[![Docker Pulls Count]][dsm-docker-hub] + +[Build Status]: https://github.com/kroese/virtual-dsm/workflows/Build%20&%20deploy%20on%20git%20tag%20push/badge.svg +[builds]: https://github.com/kroese/virtual-dsm/actions?query=workflow%3A%22Build+%26+deploy+on+git+tag+push%22 +[test]: https://github.com/kroese/virtual-dsm/actions/workflows/test.yaml/badge.svg + +[gh_last_release_svg]: https://img.shields.io/github/v/release/kroese/virtual-dsm?sort=semver +[gh_last_release_url]: https://github.com/kroese/virtual-dsm/releases/latest + +[Docker Pulls Count]: https://img.shields.io/docker/pulls/kroese/virtual-dsm.svg?style=flat +[dsm-docker-hub]: https://hub.docker.com/r/kroese/virtual-dsm A docker container for running Synology's Virtual DSM. Docker Hub: [kroese/virtual-dsm](https://hub.docker.com/r/kroese/virtual-dsm/) +## Prerequisites + +In order to use the container, you need two images called `boot.img` and `sys.img` from Synology containing the Virtual DSM 7 OS. + +Place them in the `/home/user/images` folder. A third empty image, called `data.img` will be automaticly generated with a size of 16GB. If you need more space for your DSM instance, you can manually generate a larger file by running `truncate -s 100G data.img` from your host OS. + ## Using the container Via `docker run`: @@ -40,9 +59,3 @@ services: restart: always ``` -## Prerequisites - -In order to use the container, you need two images called `boot.img` and `sys.img` from Synology containing the Virtual DSM OS. - -* a -* b