Skip to content

Commit 298b36e

Browse files
committed
docs: add screenshots & regenerate README
1 parent ae38c7b commit 298b36e

4 files changed

Lines changed: 88 additions & 20 deletions

File tree

635 KB
Loading

Containerfile.pkg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ENV HEALTHCHECK_URL="${HEALTHCHECK_ENDPOINT}"
1717

1818
# --- Metadata (Injected by Generator) ---
1919
LABEL org.opencontainers.image.title="Nextcloud" \
20-
org.opencontainers.image.description="Nextcloud self-hosted cloud on FreeBSD." \
20+
org.opencontainers.image.description="Online collaboration platform providing groupware capabilities by default, extensible with additional apps." \
2121
org.opencontainers.image.source="https://github.com/daemonless/nextcloud" \
2222
org.opencontainers.image.url="https://nextcloud.com/" \
2323
org.opencontainers.image.documentation="https://docs.nextcloud.com/" \

README.md

Lines changed: 85 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,30 @@ Source: dbuild templates
55

66
# Nextcloud
77

8-
Nextcloud self-hosted cloud on FreeBSD.
8+
[![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/nextcloud/build.yaml?style=flat-square&label=Build&color=green)](https://github.com/daemonless/nextcloud/actions)
9+
[![Last Commit](https://img.shields.io/github/last-commit/daemonless/nextcloud?style=flat-square&label=Last+Commit&color=blue)](https://github.com/daemonless/nextcloud/commits)
10+
11+
Online collaboration platform providing groupware capabilities by default, extensible with additional apps.
12+
913

1014
| | |
1115
|---|---|
1216
| **Port** | 8082 |
1317
| **Registry** | `ghcr.io/daemonless/nextcloud` |
14-
| **Docs** | [daemonless.io/images/nextcloud](https://daemonless.io/images/nextcloud/) |
1518
| **Source** | [https://github.com/nextcloud/server](https://github.com/nextcloud/server) |
1619
| **Website** | [https://nextcloud.com/](https://nextcloud.com/) |
1720

21+
## Version Tags
22+
23+
| Tag | Description | Best For |
24+
| :--- | :--- | :--- |
25+
| `latest` / `pkg` | **FreeBSD Quarterly**. Uses stable, tested packages. | Most users. Matches Linux Docker behavior. |
26+
| `pkg-latest` | **FreeBSD Latest**. Rolling package updates. | Newest FreeBSD packages. |
27+
28+
## Prerequisites
29+
30+
Before deploying, ensure your host environment is ready. See the [Quick Start Guide](https://daemonless.io/guides/quick-start) for host setup instructions.
31+
1832
## Deployment
1933

2034
### Podman Compose
@@ -29,26 +43,72 @@ services:
2943
- PGID=1000
3044
- TZ=UTC
3145
volumes:
32-
- /path/to/containers/nextcloud:/config
33-
- /path/to/data:/data
46+
- "/path/to/containers/nextcloud:/config"
47+
- "/path/to/containers/nextcloud/data:/data"
3448
ports:
3549
- 8082:8082
3650
restart: unless-stopped
3751
```
3852
53+
### AppJail Director
54+
55+
**.env**:
56+
57+
```
58+
DIRECTOR_PROJECT=nextcloud
59+
PUID=1000
60+
PGID=1000
61+
TZ=UTC
62+
```
63+
64+
**appjail-director.yml**:
65+
66+
```yaml
67+
options:
68+
- virtualnet: ':<random> default'
69+
- nat:
70+
services:
71+
nextcloud:
72+
name: nextcloud
73+
options:
74+
- container: 'boot args:--pull'
75+
oci:
76+
user: root
77+
environment:
78+
- PUID: !ENV '${PUID}'
79+
- PGID: !ENV '${PGID}'
80+
- TZ: !ENV '${TZ}'
81+
volumes:
82+
- nextcloud: /config
83+
- nextcloud_data: /data
84+
volumes:
85+
nextcloud:
86+
device: '/path/to/containers/nextcloud'
87+
nextcloud_data:
88+
device: '/path/to/containers/nextcloud/data'
89+
```
90+
91+
**Makejail**:
92+
93+
```
94+
ARG tag=latest
95+
96+
OPTION overwrite=force
97+
OPTION from=ghcr.io/daemonless/nextcloud:${tag}
98+
```
99+
39100
### Podman CLI
40101

41102
```bash
42103
podman run -d --name nextcloud \
43104
-p 8082:8082 \
44-
-e PUID=@PUID@ \
45-
-e PGID=@PGID@ \
46-
-e TZ=@TZ@ \
105+
-e PUID=1000 \
106+
-e PGID=1000 \
107+
-e TZ=UTC \
47108
-v /path/to/containers/nextcloud:/config \
48-
-v /path/to/data:/data \
109+
-v /path/to/containers/nextcloud/data:/data \
49110
ghcr.io/daemonless/nextcloud:latest
50111
```
51-
Access at: `http://localhost:8082`
52112

53113
### Ansible
54114

@@ -60,38 +120,45 @@ Access at: `http://localhost:8082`
60120
state: started
61121
restart_policy: always
62122
env:
63-
PUID: "@PUID@"
64-
PGID: "@PGID@"
65-
TZ: "@TZ@"
123+
PUID: "1000"
124+
PGID: "1000"
125+
TZ: "UTC"
66126
ports:
67127
- "8082:8082"
68128
volumes:
69129
- "/path/to/containers/nextcloud:/config"
70-
- "/path/to/data:/data"
130+
- "/path/to/containers/nextcloud/data:/data"
71131
```
72132
73-
## Configuration
133+
Access at: `http://localhost:8082`
134+
135+
## Parameters
136+
74137
### Environment Variables
75138

76139
| Variable | Default | Description |
77140
|----------|---------|-------------|
78141
| `PUID` | `1000` | User ID for the application process |
79142
| `PGID` | `1000` | Group ID for the application process |
80143
| `TZ` | `UTC` | Timezone for the container |
144+
81145
### Volumes
82146

83147
| Path | Description |
84148
|------|-------------|
85149
| `/config` | Configuration and application files |
86150
| `/data` | User data storage |
151+
87152
### Ports
88153

89154
| Port | Protocol | Description |
90155
|------|----------|-------------|
91156
| `8082` | TCP | |
92157

93-
## Notes
158+
**Architectures:** amd64
159+
**User:** `bsd` (UID/GID via PUID/PGID, defaults to 1000:1000)
160+
**Base:** FreeBSD 15.0
161+
162+
---
94163

95-
- **Architectures:** amd64
96-
- **User:** `bsd` (UID/GID set via PUID/PGID)
97-
- **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD)
164+
Need help? Join our [Discord](https://discord.gg/Kb9tkhecZT) community.

compose.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ x-daemonless:
44
title: "Nextcloud"
55
icon: ":simple-nextcloud:"
66
category: "Utilities"
7-
description: "Nextcloud self-hosted cloud on FreeBSD."
7+
description: "Online collaboration platform providing groupware capabilities by default, extensible with additional apps."
88
upstream_url: "https://github.com/nextcloud/server"
99
web_url: "https://nextcloud.com/"
1010
freshports_url: "https://www.freshports.org/www/nextcloud/"
1111
user: "bsd"
1212
mlock: false
1313
upstream_binary: false
14+
appjail: true
1415

1516
docs:
1617
env:

0 commit comments

Comments
 (0)