Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: small changes&updates #9059

Merged
merged 8 commits into from
May 11, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
```

## Activities

![Activities](https://repobeats.axiom.co/api/embed/9e86d9dc3ddd137161f2f6d2e758d7863b1789cb.svg "Repobeats analytics image")

## Features
Expand All @@ -94,7 +95,7 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
| OAuth support | Yes | Yes |
| API Keys | N/A | Yes |
| LivePhoto/MotionPhoto backup and playback | Yes | Yes |
| Support 360 degree image display | No | Yes |
| Support 360 degree image display | Yes | Yes |
aviv926 marked this conversation as resolved.
Show resolved Hide resolved
| User-defined storage structure | Yes | Yes |
| Public Sharing | No | Yes |
| Archive and Favorites | Yes | Yes |
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/administration/backup-and-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ docker compose pull # Update to latest version of Immich (if desired)
docker compose create # Create Docker containers for Immich apps without running them.
docker start immich_postgres # Start Postgres server
sleep 10 # Wait for Postgres server to start up
gunzip < "/path/to/backup/dump.sql.gz" | docker exec -i immich_postgres psql --username=postgres # Restore Backup
gunzip < "/path/to/backup/dump.sql.gz" | docker exec -i immich_postgres psql --username=postgres --dbname=immich # Restore Backup
docker compose up -d # Start remainder of Immich apps
```

Expand All @@ -47,7 +47,7 @@ docker compose pull # Update to latest version of Immich (if desired)
docker compose create # Create Docker containers for Immich apps without running them.
docker start immich_postgres # Start Postgres server
sleep 10 # Wait for Postgres server to start up
gc "C:\path\to\backup\dump.sql" | docker exec -i immich_postgres psql --username=postgres # Restore Backup
gc "C:\path\to\backup\dump.sql" | docker exec -i immich_postgres psql --username=postgres --dbname=immich # Restore Backup
aviv926 marked this conversation as resolved.
Show resolved Hide resolved
docker compose up -d # Start remainder of Immich apps
```

Expand Down
5 changes: 5 additions & 0 deletions docs/docs/developer/pr-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ When contributing code through a pull request, please check the following:
- [ ] `npm run check:svelte` (Type checking via SvelteKit)
- [ ] `npm test` (unit tests)

## Documentation

- [ ] `npm run format` (formatting via Prettier)
aviv926 marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Update the `_redirects` file if you have renamed a page or removed it from the documentation.

:::tip AIO
Run all web checks with `npm run check:all`
:::
Expand Down
5 changes: 5 additions & 0 deletions docs/src/components/community-guides.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ const guides: CommunityGuidesProps[] = [
description: 'Documentation for simple podman setup using quadlets.',
url: 'https://github.com/tbelway/immich-podman-quadlets/blob/main/docs/install/podman-quadlet.md',
},
{
title: 'gphotos import + albums',
description: 'Import your G photos files into Immich and add your albums',
aviv926 marked this conversation as resolved.
Show resolved Hide resolved
url: 'https://github.com/tbelway/immich-podman-quadlets/blob/main/docs/install/podman-quadlet.md',
},
aviv926 marked this conversation as resolved.
Show resolved Hide resolved
];

function CommunityGuide({ title, description, url }: CommunityGuidesProps): JSX.Element {
Expand Down
7 changes: 6 additions & 1 deletion docs/src/components/community-projects.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@ const projects: CommunityProjectProps[] = [
{
title: 'Remove offline files',
description: 'A Python script to remove offline files.',
url: 'https://gist.github.com/Thoroslives/ca5d8e1efd15111febc1e7b34ac72668',
url: 'https://github.com/Thoroslives/immich_remove_offline_files/tree/main',
aviv926 marked this conversation as resolved.
Show resolved Hide resolved
},
{
title: 'Move untracked files',
description: 'Script to move untracked files from within Immich directories.',
url: 'https://github.com/clumsyCoder00/Immich-Tools/tree/main?tab=readme-ov-file#move_untracked_filessh',
},
aviv926 marked this conversation as resolved.
Show resolved Hide resolved
{
title: 'Create albums from folders',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
folders that contain files you don't want to import, such as RAW files.
<br /><br />
Add exclusion patterns. Globbing using *, **, and ? is supported. To ignore all files in any directory named "Raw",
use "**/Raw/**". To ignore all files ending in ".tif", use "**/*.tif". To ignore an absolute path, use "/path/to/ignore".
use "**/Raw/**". To ignore all files ending in ".tif", use "**/*.tif". To ignore an absolute path, use "/path/to/ignore/**".
</p>
<div class="my-4 flex flex-col gap-2">
<label class="immich-form-label" for="exclusionPattern">Pattern</label>
Expand Down