icedr

KO | EN

gitlite — search

#pdf #linux #web #hacktoberfest #android #nodejs #shell #openai #llm #rust

(★ 9)

A self-hosted file sharing and cloud drive platform built for ICETOWNE.

File Explorer

ZIP Download

- - ci.yml
  - docker.yml
  - pages.yml
  - release.yml
- - create-sqlite-schema.cjs
  - inspect-transfer-lifecycle-migration.cjs
  - prepare-transfer-lifecycle-indexes.cjs
  - prisma-generate.cjs
  - prisma-prepare.cjs
- - app.controller.spec.ts
  - app.controller.ts
  - app.module.ts
  - app.service.ts
  - main.ts
- - app.e2e-spec.ts
  - jest-e2e.json
- .prettierrc
- eslint.config.mjs
- nest-cli.json
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- schema.prisma
- seed.ts
- docker-compose.dev.yml
- docker-compose.yml
- Dockerfile
- - config.mts
- - backup-restore.md
  - docker-compose.md
  - https.md
  - minio-s3.md
  - postgresql.md
  - reverse-proxy.md
  - upgrade-migration.md
- - binary.md
  - deployment.md
  - docker.md
  - getting-started.md
  - overview.md
  - setup-wizard.md
- - favicon.png
- - configuration.md
  - environment-variables.md
  - error-codes.md
  - releases.md
  - security.md
  - transfer-state-machine.md
  - troubleshooting.md
- index.md
- - favicon.png
  - ICEDR.png
  - logo.png
- - run-e2e.mjs
- - App.tsx
  - main.tsx
  - vite-env.d.ts
- .gitignore
- eslint.config.mjs
- index.html
- package.json
- playwright.config.ts
- README.md
- tsconfig.json
- vite.config.ts
- [email protected]
- binary-metadata.cjs
- create-docs-release-data.cjs
- create-release-checksums.cjs
- create-release-notes.cjs
- dev.cjs
- package-binary.cjs
.dockerignore
.env.example
.env.production.example
.gitignore
binary-metadata.json
LICENSE
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
prisma.config.ts
README.md
release_details.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

ICEDR is a self-hostable workspace drive for file management, preview, sharing, and operational audit. It ships as a Node.js monorepo with a React frontend, a NestJS backend, Prisma-backed persistence, object storage support, and container packaging for the application code.

## Features

- Workspace file management with upload, download, preview, trash, version, and quota workflows.
- External sharing with link policies, email verification, authenticated account access, preview controls, and download limits.
- Administrative panels for system status, storage, identity, sharing policy, and audit records.
- Structured audit events for workspace users, signed-in accounts, visitors, and system activity.
- SQLite-first local persistence with optional production database and object storage integrations.
- Local development defaults that can run with demo data while infrastructure is being wired up.

## Repository Layout

| Path | Purpose |
| --- | --- |
| `frontend` | Vite, React, HeroUI, Tailwind CSS, and Playwright smoke tests. |
| `backend` | NestJS API, authentication, sharing, storage, settings, and audit modules. |
| `database` | Prisma schema, SQLite schema variant, migrations, and seed entry point. |
| `deploy` | Docker image and Compose packaging configuration. |
| `docs` | VitePress documentation source, deployment guide, and release reference. |
| `scripts` | Release, checksum, and binary packaging utilities. |

## Requirements

- Node.js 24
- pnpm 10.18.1
- Docker, when building container images

## Quick Start

```bash
cp .env.example .env
pnpm install
pnpm dev:api
pnpm dev:app
```

The frontend is served at `http://localhost:13000`. The API is served at `http://localhost:13001/api`.

The browser client uses same-origin `/api` by default. During local development, Vite proxies `/api` to the backend configured by `API_HOST` and `API_PORT`, so frontend code does not need to embed a development backend origin.

The local environment file enables development-only defaults such as demo data, an in-memory fallback, and the development mail logger. These settings are intended for local work only.

## Common Commands

```bash
pnpm install
pnpm lint
pnpm build
pnpm docs:build
pnpm test
pnpm test:e2e
pnpm package:binary
pnpm docker:build
```

Useful package-scoped commands:

```bash
pnpm --filter frontend build
pnpm --filter frontend test
pnpm --filter frontend test:e2e
pnpm --filter backend build
pnpm --filter backend test
pnpm --filter backend prisma:migrate:deploy
```

Install the Playwright browser once before running the end-to-end smoke suite locally:

```bash
pnpm --filter frontend exec playwright install --with-deps chromium
```

## Configuration

Start from `.env.example` for local development and `.env.production.example` for production. Production requires separate `AUTH_SECURITY_SECRET` and `SHARE_VISITOR_HASH_SECRET` values of at least 32 characters. Deployments should also provide the public share URL, persistence, storage, cache, and SMTP values required by the selected runtime environment.

Fresh data directories open the first-run setup page. Setup starts with local SQLite and local file storage, and the database step lets administrators keep SQLite or switch to PostgreSQL before completing bootstrap. SMTP is optional during first-run setup; it can stay disabled and be configured later from the administrator settings.

The backend validates production configuration during startup. Missing values, malformed URLs or ports, development-only mail delivery, and common placeholder values cause startup to fail with clear variable names. SMTP values are required only when mail delivery is enabled.

External login should use the standard `oidc` provider profile for normal OIDC providers. The `icetowne-blog` profile remains available only for the legacy Blog OAuth shape.

Configuration reference lives in the VitePress documentation under `docs/reference/configuration.md`.

## Published Builds

The current pre-release is `v0.0.1-alpha.5`. Container images are published as `corecherry/icedr-po:<tag>` and `ghcr.io/cloudwhile/icedr-po:<tag>`. Use `0.0.1-alpha.5` as the Docker tag for this release.

Stable versions such as `v1.2.0` update the `latest` tag in both registries. Pre-release versions such as `v0.0.1-alpha.5`, `v1.2.0-alpha.1`, or `v1.2.0-beta.1` publish their own version tags but do not update `latest`.

### Minimal Docker Deployment

The Docker image contains the ICEDR web client and API in one container. Persist `/workspace/backend/data` to keep SQLite data, local files, setup state, and runtime metadata across upgrades:

```bash
mkdir -p /opt/icedr/data
umask 077
printf 'AUTH_SECURITY_SECRET=%s\n' "$(openssl rand -hex 32)" > /opt/icedr/icedr.env
printf 'SHARE_VISITOR_HASH_SECRET=%s\n' "$(openssl rand -hex 32)" >> /opt/icedr/icedr.env
printf 'SMTP_ENABLED=false\n' >> /opt/icedr/icedr.env

docker run -d \
  --name icedr \
  --restart unless-stopped \
  -p 13000:13000 \
  -v /opt/icedr/data:/workspace/backend/data \
  --env-file /opt/icedr/icedr.env \
  -e NODE_ENV=production \
  -e APP_ENV=production \
  -e API_HOST=0.0.0.0 \
  -e API_PORT=13000 \
  corecherry/icedr-po:0.0.1-alpha.5
```

Generate the two secrets once, keep them distinct, and preserve `icedr.env` across restarts and upgrades. Open `http://localhost:13000`, or replace `localhost` with the server address. A fresh data directory opens the first-run setup page.

### Minimal Binary Deployment

Standalone binaries are attached to each GitHub Release. Artifact names follow the `icedr_VERSION_PLATFORM` convention. Release notes include download links, file sizes, `MD5SUMS.txt`, `SHA256SUMS.txt`, and `release-manifest.json`.

Linux x86_64 example:

```bash
mkdir -p /opt/icedr
cd /opt/icedr
chmod +x ./icedr_0.0.1-alpha.5_linux-x86_64
./icedr_0.0.1-alpha.5_linux-x86_64
```

Binary builds create `data` beside the executable by default. Set `ICEDR_DATA_DIR` only when the data directory must live elsewhere.

Deployment details live in the VitePress documentation:

- Docker: `docs/guide/docker.md`
- Binary: `docs/guide/binary.md`
- Configuration: `docs/reference/configuration.md`
- Releases and checksums: `docs/reference/releases.md`

## Release Versioning

Examples:

```text
v1.2.0
v0.0.1-alpha.5
v1.2.0-alpha.1
v1.2.0-beta.1
```

Tags that contain a pre-release marker after the version, such as `-alpha.1` or `-beta.1`, are published as GitHub prereleases. Stable tags update the Docker `latest` image tag; pre-release tags do not.

The ICEDR runtime normalizes `v`-prefixed tags for version comparison while keeping the standard tag form in system information. Pre-release builds can detect newer pre-release and stable releases; stable builds only treat stable releases as updates by default.

Each GitHub Release includes asset links, `MD5SUMS.txt`, `SHA256SUMS.txt`, and `release-manifest.json` so downloaded files can be checked for integrity and source.

## Verification Flow

1. Open `http://localhost:13000`.
2. Confirm that the drive loads from the API.
3. Upload a small file.
4. Create an external share for the file.
5. Open the generated `/share/s/:token` link.
6. Verify access through email or an authenticated account.
7. Download or preview the shared file.
8. Review the audit log for the share, verification, preview, and download activity.

## Documentation

- `pnpm docs:dev` starts the VitePress documentation locally.
- `pnpm docs:build` builds the documentation to `docs/.vitepress/dist`.
- `.github/workflows/pages.yml` deploys the documentation to GitHub Pages.
- Documentation source is under `docs`.
- `scripts/README.md`

## License

ICEDR is licensed under the Apache License 2.0. See `LICENSE` for details.

icedr

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README