Skip to content

Commit eb4afda

Browse files
author
user
committed
Added README.md and LICENSE
1 parent 88685da commit eb4afda

File tree

2 files changed

+156
-0
lines changed

2 files changed

+156
-0
lines changed

LICENSE

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# License Information
2+
3+
This repository contains components covered by different licenses:
4+
5+
## Dockerfiles and docker-compose.yml
6+
7+
The Dockerfiles and docker-compose.yml in this repository are licensed under the MIT License:
8+
9+
```
10+
MIT License
11+
12+
Copyright (c) 2025
13+
14+
Permission is hereby granted, free of charge, to any person obtaining a copy
15+
of this software and associated documentation files (the "Software"), to deal
16+
in the Software without restriction, including without limitation the rights
17+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18+
copies of the Software, and to permit persons to whom the Software is
19+
furnished to do so, subject to the following conditions:
20+
21+
The above copyright notice and this permission notice shall be included in all
22+
copies or substantial portions of the Software.
23+
24+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30+
SOFTWARE.
31+
```
32+
33+
## Nextcloud
34+
35+
Nextcloud is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
36+
37+
For more information, see: https://github.com/nextcloud/server/blob/master/COPYING
38+
39+
## Nginx
40+
41+
Nginx is licensed under the 2-clause BSD license:
42+
43+
```
44+
/*
45+
* Copyright (C) 2002-2024 Igor Sysoev
46+
* Copyright (C) 2011-2024 Nginx, Inc.
47+
* All rights reserved.
48+
*
49+
* Redistribution and use in source and binary forms, with or without
50+
* modification, are permitted provided that the following conditions
51+
* are met:
52+
* 1. Redistributions of source code must retain the above copyright
53+
* notice, this list of conditions and the following disclaimer.
54+
* 2. Redistributions in binary form must reproduce the above copyright
55+
* notice, this list of conditions and the following disclaimer in the
56+
* documentation and/or other materials provided with the distribution.
57+
*
58+
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
59+
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60+
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61+
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
62+
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
63+
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
64+
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65+
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
66+
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
67+
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
68+
* SUCH DAMAGE.
69+
*/
70+
```
71+
72+
For more information, see: https://nginx.org/LICENSE
73+
74+
## Other Third-Party Components
75+
76+
This repository may include or reference other third-party software components that have their own license terms. Please refer to the respective source files or documentation for those components.

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Docker Compose Setup with NVIDIA GPU Support
2+
3+
This repository provides a Docker Compose configuration for running services with NVIDIA GPU acceleration.
4+
5+
## Prerequisites
6+
7+
- Docker Engine
8+
- NVIDIA GPU with compatible drivers (version 550+)
9+
- CUDA 12.4 and cuDNN 8
10+
- NVIDIA Container Toolkit
11+
12+
## Installation Steps
13+
14+
1. **Install Docker Engine**
15+
- Follow the official installation guide: https://docs.docker.com/engine/install/
16+
17+
2. **Install NVIDIA Drivers and CUDA**
18+
- Ensure NVIDIA Drivers (550+) are installed
19+
- Install CUDA 12.4: https://developer.nvidia.com/cuda-12-4-0-download-archive
20+
- Install cuDNN 8: https://developer.nvidia.com/rdp/cudnn-archive
21+
22+
3. **Install NVIDIA Container Toolkit**
23+
- Follow the installation guide: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html
24+
25+
4. **Setup Docker Compose**
26+
- Rename `docker-compose.example.yml` to `docker-compose.yml`
27+
28+
5. **Generate SSL Certificates**
29+
- See instructions below
30+
31+
6. **Start the Services**
32+
- Run `docker compose up -d --build`
33+
34+
## Generating SSL Certificates
35+
36+
### On Linux
37+
38+
```bash
39+
# Generate a private key
40+
openssl genrsa -out server.key 2048
41+
42+
# Generate a certificate signing request
43+
openssl req -new -key server.key -out server.csr
44+
45+
# Generate a self-signed certificate
46+
openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt
47+
```
48+
49+
### On Windows with PuTTY
50+
51+
1. Generate SSL certificates using OpenSSL:
52+
- Install OpenSSL for Windows
53+
- Use the same commands as Linux above in Command Prompt or PowerShell
54+
55+
2. If you already have a PuTTY (.ppk) key and need to convert it:
56+
- Use PuTTYgen to load your .ppk file
57+
- Go to Conversions -> Export OpenSSH key
58+
- Save the exported key as `server.key`
59+
60+
## GPU Compatibility
61+
62+
Make sure your GPU supports CUDA 12.4 compute capability. Check the NVIDIA support matrix to confirm compatibility:
63+
https://docs.nvidia.com/deeplearning/cudnn/backend/latest/reference/support-matrix.html
64+
65+
You may need to select a different CUDA version based on your GPU model.
66+
67+
## Usage
68+
69+
After following the installation steps and starting the services with `docker compose up -d`, you can access the application according to the configuration in your docker-compose.yml file.
70+
71+
## Troubleshooting
72+
73+
- If you encounter issues with NVIDIA GPU support, ensure the NVIDIA Container Toolkit is properly installed and configured
74+
- Check docker logs with `docker compose logs` to diagnose issues
75+
76+
## Additional Resources
77+
78+
You can find a tutorial that goes a bit more in depth here: https://jaredweisinger.blog/setting-up-nextcloud-v30-fpm-with-nginx-and-cuda-cudnn8-for-the-recognize-app-on-ubuntu-24-04-605ffdcaba44
79+
80+
If you run into any problems, comment on that article and I will be happy to help.

0 commit comments

Comments
 (0)