Skip to content
This repository was archived by the owner on Dec 4, 2025. It is now read-only.

Commit d788cbd

Browse files
Updated documentation in For Ubuntu Linux and Docker sections (#22)
Updated documentation in For Ubuntu Linux and Docker sections WE2-572 Signed-off-by: Mihkel Kivisild <[email protected]>
1 parent 209c2ac commit d788cbd

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ The ASP.NET web application makes use of the following technologies:
1313
- the Web eID JavaScript library [_web-eid.js_](https://github.com/web-eid/web-eid.js),
1414
- the digital signing library [_libdigidocpp_](https://github.com/open-eid/libdigidocpp/tree/master/examples/DigiDocCSharp).
1515

16+
Note that for including the Web eID authentication token validation library as a nuget package you need to have added a Package Source with the following address to the NuGet Package Manager:
17+
https://gitlab.com/api/v4/projects/35362906/packages/nuget/index.json
18+
1619
## Quickstart
1720

1821
Complete the steps below to run the example application in order to test authentication and digital signing with Web eID.
@@ -51,25 +54,35 @@ Set up the `libdigidocpp` library as follows:
5154
#### For Ubuntu Linux
5255

5356
1. Add RIA repository to install the official _libdigidocpp-csharp_ package:
54-
```sh
55-
wget https://github.com/web-eid/web-eid-asp-dotnet-example/raw/main/src/ria_public_key.gpg
56-
cp ria_public_key.gpg /usr/share/keyrings/ria-repository.gpg
57-
echo "deb [signed-by=/usr/share/keyrings/ria-repository.gpg] https://installer.id.ee/media/ubuntu/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/ria-repository.list
58-
```
57+
```sh
58+
wget https://github.com/web-eid/web-eid-asp-dotnet-example/raw/main/src/ria_public_key.gpg
59+
cp ria_public_key.gpg /usr/share/keyrings/ria-repository.gpg
60+
echo "deb [signed-by=/usr/share/keyrings/ria-repository.gpg] https://installer.id.ee/media/ubuntu/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/ria-repository.list
61+
```
5962
2. Install the _libdigidocpp-csharp_ package:
60-
```sh
61-
apt update
62-
apt install -y --no-install-recommends libdigidocpp-csharp
63-
```
63+
```sh
64+
apt update
65+
apt install -y --no-install-recommends libdigidocpp-csharp
66+
```
67+
3. Navigate to the `src` directory:
68+
69+
```sh
70+
cd src
71+
```
72+
4. Copy the necessary DigiDoc C# library files into your project:
73+
74+
```sh
75+
cp /usr/include/digidocpp_csharp/* WebEid.AspNetCore.Example/DigiDoc/
76+
```
6477

6578
#### For macOS
6679

6780
1. Install the _libdigidocpp-3.17.1.pkg_ package or higher. The installation packages are available from [https://github.com/open-eid/libdigidocpp/releases](https://github.com/open-eid/libdigidocpp/releases).
6881
2. Copy the C# source files from `/Library/libdigidocpp/include/digidocpp_csharp` directory to `src/WebEid.AspNetCore.Example/DigiDoc` directory.
6982
3. Go to `src/WebEid.AspNetCore.Example/bin/.../net60` directory and create symbolic link to `/Library/libdigidocpp/lib/libdigidoc_csharp.dylib` library:
70-
```cmd
71-
ln -s /Library/libdigidocpp/lib/libdigidoc_csharp.dylib
72-
```
83+
```cmd
84+
ln -s /Library/libdigidocpp/lib/libdigidoc_csharp.dylib
85+
```
7386

7487
Further information is available in the [libdigidocpp example C# application source code](https://github.com/open-eid/libdigidocpp/tree/master/examples/DigiDocCSharp) and in the [`libdigidocpp` Wiki](https://github.com/open-eid/libdigidocpp/wiki).
7588

@@ -149,6 +162,8 @@ You can install them using the following command:
149162
sudo apt install dotnet-sdk-7.0 libdigidocpp-csharp
150163
```
151164

165+
Note: Before installing `libdigidocpp-csharp` you have to have added the RIA repository as a package source. See [For Ubuntu Linux section](#for-ubuntu-linux) for information.
166+
152167
### Building the application
153168

154169
To build the application, follow these steps:
@@ -219,4 +234,4 @@ app.UseForwardedHeaders(new ForwardedHeadersOptions
219234
220235
By default, this middleware is already enabled in the application.
221236
222-
A Docker Compose configuration file `docker-compose.yml` is available in the `src` directory for running the Docker image `web-eid-asp-dotnet-example` on port 8480 behind a reverse proxy.
237+
A Docker Compose configuration file `docker-compose.yml` is available in the `src` directory for running the Docker image `web-eid-asp-dotnet-example` on port 8480 behind a reverse proxy.

0 commit comments

Comments
 (0)