Skip to content

Commit b84c1a7

Browse files
mmomjianvladd11
authored andcommitted
feat(docs): CIFS/Samba in-Docker example (immich-app#15502)
* CIFS * quotes * quote 2 * quote 3, lol
1 parent 03a16a1 commit b84c1a7

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/docs/FAQ.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,35 @@ For example, say you have existing transcodes with the policy "Videos higher tha
160160

161161
No. Our design principle is that the original assets should always be untouched.
162162

163+
### How can I mount a CIFS/Samba volume within Docker?
164+
165+
If you aren't able to or prefer not to mount Samba on the host (such as Windows environment), you can mount the volume within Docker.
166+
Below is an example in the `docker-compose.yml`.
167+
168+
Change your username, password, local IP, and share name, and see below where the line `- originals:/usr/src/app/originals`,
169+
corrolates to the section where the volume `originals` was created. You can call this whatever you like, and map it to the docker container as you like.
170+
For example you could change `originals:` to `Photos:`, and change `- originals:/usr/src/app/originals` to `Photos:/usr/src/app/photos`.
171+
172+
```diff
173+
...
174+
services:
175+
immich-server:
176+
...
177+
volumes:
178+
# Do not edit the next line. If you want to change the media storage location on your system, edit the value of UPLOAD_LOCATION in the .env file
179+
- ${UPLOAD_LOCATION}:/usr/src/app/upload
180+
- /etc/localtime:/etc/localtime:ro
181+
+ - originals:/usr/src/app/originals
182+
...
183+
volumes:
184+
model-cache:
185+
+ originals:
186+
+ driver_opts:
187+
+ type: cifs
188+
+ o: 'iocharset=utf8,username=USERNAMEHERE,password=PASSWORDHERE,rw' # change to `ro` if read only desired
189+
+ device: '//localipaddress/sharename'
190+
```
191+
163192
---
164193

165194
## Albums

0 commit comments

Comments
 (0)