Bỏ qua để đến nội dung
Oleaflyv0.4.12

Chạy máy chủ

Thiết lập nhà cung cấp đăng nhập và email cho Oleafly Server, quyết định ai được vào bằng quy tắc truy cập, đăng ký mở, vai trò và khách, bật quyền truy cập qua trình duyệt, và vận hành máy chủ từ bảng điều khiển quản trị.

Mọi người đăng nhập vào Oleafly Server thông qua các nhà cung cấp mà bạn cấu hình, nên máy chủ không bao giờ xử lý mật khẩu. Bạn quyết định ai được vào bằng quy tắc truy cập. Các quản trị viên quản lý phần việc còn lại từ bảng điều khiển quản trị trong Oleafly.

Hãy cấu hình ít nhất một nhà cung cấp. Máy chủ sẽ không khởi động nếu thiếu nó, và nhật ký của máy chủ nêu tên các cài đặt cần thêm. Quản trị viên đầu tiên đăng nhập bằng chính nhà cung cấp đó, vì đăng nhập bằng liên kết email vẫn tắt cho đến khi một quản trị viên bật nó lên. Mỗi nhà cung cấp đưa mọi người quay lại một địa chỉ callback trên máy chủ của bạn:

https://collab.example.org/auth/callback/<provider>

Nếu OLEAFLY_PUBLIC_URL có đường dẫn thì địa chỉ callback cũng có đường dẫn, ví dụ https://www.cs.example.edu/oleafly/auth/callback/github.

  1. Trên GitHub, chọn ảnh đại diện của bạn, rồi Settings › Developer settings › OAuth apps, và chọn New OAuth App. Với ứng dụng thuộc sở hữu của một tổ chức, hãy dùng Developer settings trong phần cài đặt của tổ chức đó thay thế.
  2. Điền Application name (ví dụ Smith Lab Oleafly), Homepage URL (https://collab.example.org) và Authorization callback URL (https://collab.example.org/auth/callback/github). Để Enable Device Flow ở trạng thái tắt.
  3. Chọn Register application. Sao chép Client ID, rồi chọn Generate a new client secret và sao chép secret.
  4. Đặt OLEAFLY_GITHUB_CLIENT_ID và OLEAFLY_GITHUB_CLIENT_SECRET, rồi khởi động lại máy chủ.

Máy chủ chỉ yêu cầu GitHub cung cấp hồ sơ và các địa chỉ email của người dùng (read:user và user:email). OLEAFLY_GITHUB_LABEL thay đổi chữ trên nút đăng nhập.

Với GitHub Enterprise Server, hãy đăng ký ứng dụng ở đó và đặt OLEAFLY_GITHUB_URL thành địa chỉ của nó, chẳng hạn https://github.example.edu. Chỉ đặt OLEAFLY_GITHUB_API_URL nếu địa chỉ API của bạn khác thường.

OpenID Connect bao gồm GitLab, Google, Microsoft Entra ID, Keycloak, Authentik, Okta và hầu hết các hệ thống đăng nhập một lần của trường đại học. Nếu trường đại học của bạn chỉ cung cấp SAML, hãy đặt Keycloak hoặc Dex ở giữa.

  1. Chọn một tên ngắn gồm chữ cái và chữ số, chẳng hạn GITLAB. Nó trở thành một phần của tên biến, và khi viết thường nó trở thành một phần của địa chỉ callback. Trong tệp .env của Compose, hãy đổi tên các dòng UNIVERSITY hoặc thêm một khối thứ hai.

  2. Đăng ký một ứng dụng với nhà cung cấp của bạn. Chọn loại ứng dụng confidential hoặc web, đặt redirect URI thành https://collab.example.org/auth/callback/gitlab, và cho phép các scope openid, email và profile.

  3. Thêm thông tin chi tiết của nhà cung cấp:

    OLEAFLY_OIDC_GITLAB_ISSUER=https://gitlab.com
    OLEAFLY_OIDC_GITLAB_CLIENT_ID=example-client-id
    OLEAFLY_OIDC_GITLAB_CLIENT_SECRET=example-client-secret
    OLEAFLY_OIDC_GITLAB_LABEL=GitLab
  4. Khởi động lại máy chủ.

Label là chữ trên nút đăng nhập, chẳng hạn University login. Issuer là địa chỉ mà nhà cung cấp công bố /.well-known/openid-configuration dưới đó. Một số giá trị phổ biến:

Nhà cung cấpIssuer
GitLab.comhttps://gitlab.com
GitLab tự quản lýĐịa chỉ GitLab của bạn, chẳng hạn https://gitlab.example.edu
Googlehttps://accounts.google.com
Microsoft Entra IDhttps://login.microsoftonline.com/ tiếp theo là tenant ID của bạn và /v2.0
Keycloakhttps://sso.example.edu/realms/ tiếp theo là tên realm

Các mục trong danh sách cho phép và các quy tắc tên miền chỉ khớp với các địa chỉ email đã xác minh. Máy chủ chỉ coi một địa chỉ là đã xác minh khi nhà cung cấp xác nhận điều đó: GitHub đánh dấu nó là đã xác minh, hoặc claim email_verified của OpenID Connect là true.

Một số nhà cung cấp của tổ chức bỏ qua claim đó. Nếu nhà cung cấp của bạn như vậy, và nó chỉ cấp các địa chỉ do tổ chức của bạn kiểm soát, hãy đặt OLEAFLY_OIDC_<NAME>_TRUST_EMAIL=true. Đừng bao giờ đặt biến này cho một nhà cung cấp mà ở đó mọi người có thể gõ địa chỉ email tùy ý. Bất kỳ ai khi đó cũng có thể đăng nhập với tư cách một người nào đó trong danh sách cho phép của bạn.

Chứng chỉ do trường đại học của bạn ký

Phần tiêu đề “Chứng chỉ do trường đại học của bạn ký”

Nếu trường đại học của bạn tự ký chứng chỉ của riêng mình, cho proxy hoặc dịch vụ đăng nhập của trường, thì máy chủ phải tin tưởng tổ chức cấp chứng chỉ đó. Mọi máy tính chạy Oleafly cũng vậy.

Nếu không dùng Docker, hãy thêm chứng chỉ vào hệ điều hành. Trên Debian và Ubuntu, sao chép nó vào /usr/local/share/ca-certificates/ với tên tệp kết thúc bằng .crt và chạy sudo update-ca-certificates.

Ảnh Docker không có trình quản lý gói, nên hãy cung cấp cho nó một danh sách chứng chỉ bao gồm cả chứng chỉ của bạn. Cạnh docker-compose.yml, trên một máy Debian hoặc Ubuntu:

Cửa sổ terminal
cat /etc/ssl/certs/ca-certificates.crt university-ca.pem > ca-bundle.pem
chmod 644 ca-bundle.pem

Sau đó thêm tệp đó vào máy chủ trong docker-compose.override.yml và chạy lại docker compose up -d:

services:
oleafly-server:
volumes:
- ./ca-bundle.pem:/etc/ssl/certs/ca-certificates.crt:ro

Email là tùy chọn, và mọi thứ khác vẫn hoạt động mà không cần nó. Không có email, bạn tự gửi địa chỉ máy chủ cho mọi người, và Oleafly liệt kê các dự án được chia sẻ với từng người dưới Shared with you.

Để thiết lập, hãy cung cấp cho máy chủ một tài khoản SMTP:

OLEAFLY_SMTP_URL=smtps://oleafly%40example.org:example-app-password@smtp.example.org:465
OLEAFLY_MAIL_FROM=Smith Lab <oleafly@example.org>

Hoặc đặt cả hai dòng, hoặc không đặt dòng nào. Viết các ký tự đặc biệt trong tên người dùng và mật khẩu theo dạng URL, ví dụ %40 cho @.

  • smtps:// dùng TLS ngay từ đầu, trên cổng 465 trừ khi bạn chỉ định cổng khác.
  • smtp:// dùng cổng 587 trừ khi bạn chỉ định cổng khác, rồi chuyển sang TLS bằng STARTTLS. Nếu máy chủ thư không cung cấp STARTTLS, máy chủ sẽ không gửi.
  • Một mail relay trên cùng máy là ngoại lệ: smtp://localhost, smtp://127.0.0.1 và smtp://[::1] gửi mà không cần TLS.
  • Một relay trên cùng mạng riêng có thể bỏ TLS khi bạn thêm ?tls=none, như trong smtp://mailpit:1025?tls=none. Khi đó địa chỉ không thể chứa tên người dùng hay mật khẩu, vì chúng sẽ đi qua mạng mà không được mã hóa. Chỉ dùng cách này khi không ai khác có thể truy cập mạng đó.

Máy chủ kiểm tra chứng chỉ của máy chủ thư với các chứng chỉ được tin cậy của hệ thống.

Có sáu loại email. Email gửi đến người đã có tài khoản chỉ đến các địa chỉ đã xác minh của họ, và các địa chỉ noreply của GitHub luôn bị bỏ qua.

EmailKhi nào được gửi
Được thêm vào máy chủMột quản trị viên thêm ai đó vào danh sách cho phép theo địa chỉ email. Email có tên máy chủ, một liên kết Add to Oleafly và địa chỉ máy chủ. Thêm ai đó theo tên người dùng GitHub hoặc qua quy tắc tên miền sẽ không gửi gì, vì máy chủ chưa có địa chỉ của họ.
Dự án được chia sẻChủ sở hữu dự án thêm ai đó vào một dự án. Email có tiêu đề dự án, người chia sẻ nó, vai trò của họ và một liên kết mở dự án, cùng trang web của dự án cho trường hợp liên kết không mở được ứng dụng. Thay đổi vai trò về sau sẽ không gửi gì. Mỗi người có thể tắt loại email này trên thẻ máy chủ trong Settings → Collaboration.
Thiết bị mớiMột tài khoản đăng nhập trên thiết bị khác. Email có tên thiết bị, hệ điều hành của nó và thời gian theo múi giờ của máy chủ, kèm lời nhắc đăng xuất thiết bị đó nếu đó không phải là họ. Thiết bị đầu tiên của một tài khoản mới không nhận email. Đặt TZ, ví dụ TZ=Europe/Berlin, để chọn múi giờ.
Lời mời kháchChủ sở hữu dự án mời một khách. Email có tiêu đề dự án, người mời họ, một liên kết Add to Oleafly và địa chỉ dùng để đăng nhập. Khi tính năng phê duyệt bật, email được gửi sau khi lời mời được phê duyệt.
Đề cậpAi đó đề cập một thành viên trong bình luận hoặc trả lời. Email nêu người đã đề cập họ, dự án và tệp, đoạn văn mà bình luận gắn vào cùng nội dung bình luận, kèm một liên kết mở bình luận trong Oleafly. Email được gửi khoảng một phút sau khi bình luận đến máy chủ, và các lần đề cập cùng một người trong khoảng phút đó được gộp chung thành một email. Không ai nhận email cho bình luận của chính mình hoặc về một dự án họ không thể mở, và việc chỉnh sửa bình luận không bao giờ gửi lại cùng một lần đề cập. Mỗi người có thể tắt loại email này bằng Email me when someone mentions me in a comment trên thẻ máy chủ trong Settings → Collaboration.
Liên kết đăng nhậpAi đó yêu cầu một liên kết trên trang đăng nhập của máy chủ.

Các quản trị viên có thể dừng mọi loại, trừ liên kết đăng nhập, bằng Email notifications trong cài đặt máy chủ. Liên kết đăng nhập luôn được gửi, vì mọi người không thể đăng nhập nếu thiếu chúng.

Trong bảng điều khiển quản trị, mở Email. Trang này cho biết email có đang bật và địa chỉ From, không bao giờ hiển thị mật khẩu. Một quản trị viên có thể chọn Send test email để gửi thử đến địa chỉ đã xác minh của chính mình. Trang sau đó cho biết email đã đi ra hay chưa, hoặc máy chủ thư đã trả lời gì.

Khi email tắt, trang hiển thị liên kết Add to Oleafly và địa chỉ máy chủ, để bạn có thể tự gửi chúng.

Việc gửi không bao giờ làm chặn hành động phía sau nó. Máy chủ giữ các email trong một hàng đợi ở bộ nhớ và thử lại sau 30 giây, 2 phút, 10 phút, 30 phút và 2 giờ. Mỗi lần thử thất bại là một cảnh báo trong nhật ký máy chủ, và trang Email hiển thị lần thất bại gần nhất. Nếu lần thử cuối cùng cũng thất bại, máy chủ ghi lại một lỗi và bỏ email đó. Các email vẫn đang chờ khi máy chủ khởi động lại sẽ bị mất.

Mọi người cũng có thể đăng nhập bằng một liên kết mà máy chủ gửi qua email cho họ, nên họ không cần tài khoản GitHub hay OpenID Connect. Cách này cần email. Sau đó một quản trị viên bật Sign in by email trong cài đặt máy chủ. Tính năng này tắt theo mặc định.

Người đó chọn Continue with Email trong Oleafly, nhập địa chỉ của mình trong trình duyệt và chọn Email me a link. Liên kết chỉ dùng được một lần, trong 15 phút, trên máy tính đã yêu cầu nó. Mở liên kết sẽ hiện một trang có nút Sign in. Chỉ mở trang thôi thì chưa làm mất liên kết, nên trình quét thư tự đi theo các liên kết không thể làm nó hết hiệu lực.

Các quy tắc truy cập của bạn vẫn quyết định ai được vào: một mục trong danh sách cho phép cho địa chỉ email đó, một quy tắc tên miền hoặc một lời mời khách. Mục trong danh sách cho phép theo tên người dùng GitHub không khớp với liên kết email. Trang hiển thị thông điệp giống nhau bất kể máy chủ có cho địa chỉ đó vào hay không, nên không ai có thể dùng nó để dò xem ai có tài khoản.

Việc bật tính năng này cũng mở các tài khoản hiện có cho liên kết email. Một liên kết sẽ đăng nhập vào tài khoản đã có địa chỉ đó với tư cách một địa chỉ đã xác minh. Máy chủ giữ mọi địa chỉ đã xác minh mà một nhà cung cấp từng báo cáo cho một tài khoản, không chỉ địa chỉ chính, và nó giữ một địa chỉ ngay cả sau khi người đó gỡ nó khỏi nhà cung cấp. GitHub, chẳng hạn, báo cáo mọi địa chỉ đã xác minh trên tài khoản GitHub. Vì vậy bất kỳ ai đọc được thư tại một trong các địa chỉ đó đều có thể đăng nhập vào tài khoản đó bằng email. Trước khi bật, hãy kiểm tra xem mọi người vẫn còn kiểm soát mọi địa chỉ trên tài khoản của họ hay không.

Nếu một địa chỉ thuộc về nhiều hơn một tài khoản, liên kết sẽ không đăng nhập vào tài khoản nào. Nếu tài khoản duy nhất có địa chỉ đó bị đình chỉ hoặc bị xóa, liên kết bị từ chối cho đến khi bạn cho người đó quay lại.

Máy chủ gửi tối đa 3 liên kết đến một địa chỉ email và 100 liên kết đến một địa chỉ IP trong 15 phút, nên một lớp 50 người dùng chung một địa chỉ vẫn có thể đăng nhập hết. OLEAFLY_EMAIL_LINKS_PER_ADDRESS và OLEAFLY_EMAIL_LINKS_PER_IP thay đổi các con số này. Mọi địa chỉ IPv6 trong cùng một mạng /64 được tính là một địa chỉ. Tắt Sign in by email sẽ vô hiệu các liên kết đã gửi.

Khi trình duyệt không thể quay lại Oleafly sau khi đăng nhập, chẳng hạn trên một máy tính bị khóa chặt, mọi người có thể đăng nhập bằng mã. Cách này không cần cài đặt gì và hoạt động với mọi tùy chọn đăng nhập mà máy chủ có.

Oleafly hiển thị địa chỉ máy chủ của bạn, tiếp theo là /auth/device, cùng một mã gồm tám chữ cái. Người đó mở địa chỉ đó trên bất kỳ điện thoại hay máy tính nào, gõ mã, kiểm tra tên máy tính mà trang hiển thị, rồi đăng nhập. Việc đăng nhập phải hoàn tất trong trình duyệt nơi họ đã gõ mã, nên một trang đăng nhập mà người khác gửi cho họ dưới dạng liên kết sẽ không đăng nhập cho ai cả.

Một mã chỉ dùng được một lần, ngừng hoạt động sau 10 phút, và chỉ bản Oleafly đã yêu cầu mã mới có thể hoàn tất việc đăng nhập. Stop, this wasn’t me sẽ hủy nó. Một địa chỉ IP có thể yêu cầu 100 mã và gõ sai 10 mã trong 10 phút. Đủ cho một lớp 50 người dùng chung một địa chỉ, và OLEAFLY_DEVICE_CODES_PER_IP thay đổi con số này.

Đăng nhập thôi chưa đủ để vào được. Phải có một quy tắc truy cập cho phép người đó vào. Hãy quản lý chúng dưới Access rules trong bảng điều khiển quản trị:

  • Allowed people: thêm một người theo địa chỉ email, hoặc theo tên người dùng GitHub, kèm vai trò họ nhận được. Tên người dùng chỉ hoạt động với GitHub, vì các nhà cung cấp khác cho phép người dùng chọn hoặc đổi tên của mình. Nếu máy chủ gửi email, việc thêm ai đó theo địa chỉ email sẽ gửi cho họ địa chỉ máy chủ và một liên kết Add to Oleafly.
  • Domains: cho phép mọi người có địa chỉ email đã xác minh tại một tên miền, chẳng hạn cs.example.edu, đăng nhập với vai trò bạn chọn.

Sau khi bạn đã thêm mọi người, họ có thể thêm máy chủ trong Oleafly và đăng nhập.

Dưới People, bạn có thể thay đổi vai trò của một người, đình chỉ hoặc kích hoạt lại họ, xóa họ và đăng xuất thiết bị của họ. Người bị đình chỉ vẫn giữ tài khoản nhưng không thể đồng bộ cho đến khi bạn kích hoạt lại. Các thay đổi của họ vẫn nằm trên máy tính của họ.

Người bị bạn xóa sẽ ở ngoài, kể cả khi một quy tắc tên miền bao gồm địa chỉ của họ hoặc một chủ sở hữu dự án mời họ làm khách. Để cho họ quay lại, hãy thêm lại họ theo địa chỉ email hoặc tên người dùng. Họ nhận lại tài khoản cũ của mình, cùng mọi dự án họ từng có.

Với một máy chủ mà ai cũng được dùng, hãy đặt OLEAFLY_OPEN_SIGNUP=true rồi khởi động lại máy chủ. Khi đó bất kỳ ai đăng nhập bằng một trong các nhà cung cấp của bạn đều nhận một tài khoản với vai trò Member, không cần mục trong danh sách cho phép hay quy tắc tên miền. Khi Sign in by email đang bật, liên kết email cũng hoạt động như vậy.

Đăng ký mở vẫn chặn những người bạn đã xóa hoặc đình chỉ, và bất kỳ ai có địa chỉ đã xác minh thuộc về một tài khoản đã bị xóa. Khi tính năng khách được cho phép, người có lời mời khách mà đăng nhập sẽ trở thành thành viên, và vẫn nhận các dự án họ được mời vào.

Nó cũng bật giới hạn cho mỗi tài khoản: trừ khi bạn đặt giá trị khác, mỗi tài khoản được lưu 100 MB, sở hữu 50 dự án dùng chung và tải lên 300 lần mỗi giờ.

Bảng điều khiển quản trị không cho biết đăng ký mở có đang bật hay không. Nhật ký máy chủ ghi điều đó mỗi lần máy chủ khởi động: “Open sign-up is on, so anyone who signs in gets an account as a member.” Các thành viên có thể tra cứu nhau khi chia sẻ một dự án, nên trên một máy chủ mở, hãy cân nhắc tắt Member directory trong cài đặt máy chủ.

Mỗi người có một vai trò trên máy chủ, do các quản trị viên và người duy trì cấp. Trong mỗi dự án họ được thêm vào, họ còn có một vai trò dự án, do chủ sở hữu dự án đó cấp. Vai trò liệt kê các vai trò dự án: Owner, Editor, Reviewer, Commenter và Viewer.

Không vai trò máy chủ nào tự mình mở được một dự án. Quyền truy cập dự án chỉ đến từ chủ sở hữu dự án.

Hành độngQuản trị viênNgười duy trìThành viênKhách
Thêm máy chủ vào OleaflyCóCóCóCó
Xem danh sách thành viênCóCóCó, trừ khi quản trị viên ẩn nóKhông
Chia sẻ một dự ánCóCóCóKhông
Đọc nhật ký bảo mậtCóCóKhôngKhông
Thêm thành viên vào máy chủCóCóKhôngKhông
Bổ nhiệm người duy trìCóKhôngKhôngKhông
Thay đổi cài đặt máy chủCóKhôngKhôngKhông
Xóa một dự án để giải phóng dung lượngCóKhôngKhôngKhông
Đăng xuất thiết bị của người khácCóCó, nhưng không áp dụng cho thiết bị của quản trị viên hoặc người duy trì khácChỉ thiết bị của chính họChỉ thiết bị của chính họ
Đọc các dự án lưu trữ bằng truy cập trực tiếp máy chủKhông có trong ứng dụngKhông có trong ứng dụngKhông có trong ứng dụngKhông có trong ứng dụng

Hàng cuối cùng quan trọng nhất. Các dự án không được mã hóa trên máy chủ, nên bất kể ai vận hành máy đó đều có thể đọc mọi dự án được lưu trữ, dù vai trò là gì. Oleafly không dành cho vai trò nào, kể cả quản trị viên, cách làm điều đó từ ứng dụng. Khi một quản trị viên xóa dự án để giải phóng dung lượng, chủ sở hữu và các thành viên của nó được báo, và bản sao của riêng họ vẫn nằm trên máy tính của họ.

Khách là người từ bên ngoài máy chủ của bạn, chẳng hạn một đồng tác giả ở trường đại học khác, được chủ sở hữu dự án mời vào một dự án. Khách chỉ thấy các dự án họ được mời vào.

Trên máy chủ mới, tính năng khách tắt. Một quản trị viên bật nó bằng Allow guests trong cài đặt máy chủ. Approve guests first bật theo mặc định, nên một quản trị viên hoặc người duy trì phê duyệt từng lời mời trước khi nó có hiệu lực. Tắt nó để lời mời có hiệu lực ngay lập tức. Khi một quản trị viên hoặc người duy trì gửi lời mời, nó được phê duyệt ngay.

Nếu bạn tắt Allow guests sau này, các chủ sở hữu không thể gửi lời mời mới và các lời mời chưa dùng ngừng hoạt động. Khách đã đăng nhập vẫn giữ các dự án của mình cho đến khi một chủ sở hữu xóa họ hoặc bạn xóa họ dưới People.

Chỉ chủ sở hữu của một dự án mới có thể mời khách vào nó, từ hộp thoại Share của dự án.

  • Một lời mời áp dụng cho một địa chỉ và một dự án, và nó hết hạn sau 14 ngày.
  • Một người có thể gửi tối đa 20 lời mời mỗi giờ.
  • Khi tính năng phê duyệt bật, lời mời chờ dưới Pending guests ở đầu trang People. Các quản trị viên và người duy trì phê duyệt, từ chối hoặc rút lại nó ở đó. Chủ sở hữu cũng có thể rút lại nó.
  • Nếu máy chủ gửi email và Email notifications bật, khách nhận được email mời. Nếu không, Oleafly đưa cho chủ sở hữu một liên kết Add to Oleafly để tự gửi.
  • Nếu dự án đã có số người bằng mức máy chủ cho phép, lời mời sẽ chờ, và có hiệu lực vào lần đăng nhập kế tiếp của người đó sau khi ai đó đã rời đi.

Khách thêm máy chủ và đăng nhập bằng bất kỳ tùy chọn nào cung cấp cho máy chủ địa chỉ được mời với tư cách địa chỉ đã xác minh: GitHub, một nhà cung cấp OpenID Connect hoặc một liên kết email. Địa chỉ chưa xác minh không được tính. Lần đăng nhập đầu tiên tạo một tài khoản khách và mở mọi dự án mà địa chỉ đó được mời vào.

Khách có thể mở và biên dịch các dự án họ được mời vào, chỉnh sửa chúng nếu vai trò của mình cho phép, và đăng xuất thiết bị của chính họ. Họ không thể xem danh bạ thành viên hay địa chỉ email của bất kỳ ai, chia sẻ dự án, mời người khác, hoặc tham gia một dự án qua liên kết của nó. Để đưa cho một khách một dự án khác, chủ sở hữu dự án đó mời cùng địa chỉ đó.

Khi một khách bị xóa khỏi dự án cuối cùng của mình, hoặc tự rời nó, máy chủ chấm dứt quyền truy cập của họ. Nó xóa tài khoản và đăng xuất mọi thiết bị. Một lời mời mới đưa cùng tài khoản đó trở lại. Nếu bạn xóa một khách dưới People khi họ vẫn còn dự án, lời mời mới sẽ không đưa họ trở lại.

Khi một chủ sở hữu xóa ai đó khỏi một dự án, là khách hay không, người đó không thể quay lại qua liên kết của dự án, kể cả khi chia sẻ qua liên kết đang bật. Mỗi lần thử hiện trong nhật ký bảo mật. Để cho họ quay lại, chủ sở hữu thêm lại họ, hoặc gửi một lời mời mới nếu họ là khách. Người tự rời một dự án vẫn có thể tham gia lại qua liên kết của nó.

Khi bật quyền truy cập qua trình duyệt, mọi người có thể mở các dự án được chia sẻ với họ trong trình duyệt web mà không cần cài Oleafly. Họ chỉnh sửa, đề xuất thay đổi, bình luận, trò chuyện và đọc PDF mới nhất đã biên dịch. Làm việc trong trình duyệt mô tả những gì họ thấy.

Đặt OLEAFLY_WEB=true rồi khởi động lại máy chủ. Image container được phát hành có sẵn ứng dụng trình duyệt. Một bản dựng không có ứng dụng này ghi vào nhật ký “OLEAFLY_WEB is true, but this build of Oleafly Server has no browser app, so browser access stays off.”

Sau khi bật:

  • Ứng dụng trình duyệt nằm tại địa chỉ máy chủ của bạn, tiếp theo là /web/, chẳng hạn https://collab.example.org/web/. Trang của mỗi dự án dưới /p/ cũng có thêm liên kết Open in browser.
  • Mọi người đăng nhập tại /web/sign-in bằng cùng các nhà cung cấp và liên kết email như trong Oleafly, và cùng các quy tắc truy cập quyết định ai được vào. Một trình duyệt giữ trạng thái đăng nhập trong 30 ngày.
  • Mỗi trình duyệt được tính là một thiết bị của tài khoản đó, với tên như “Safari on macOS”. Nó hiện trong danh sách thiết bị của người đó và trong nhật ký bảo mật, và đăng xuất nó sẽ kết thúc phiên của trình duyệt đó.
  • Trình duyệt kết nối tới /web/ws bằng WebSocket và không có tuyến chậm hơn, nên proxy của bạn phải chuyển tiếp các yêu cầu nâng cấp WebSocket tại đó. Caddy và các ví dụ nginx và Apache trong Sau một reverse proxy đã làm vậy.
  • PDF mà mọi người đọc là bản mới nhất mà một chủ sở hữu hoặc người chỉnh sửa đã biên dịch trong Oleafly. PDF đã biên dịch giải thích cách nó đến đó.

Ứng dụng trình duyệt không thể hiển thị bên trong một khung trên trang web khác. Nó chỉ kết nối tới máy chủ của bạn, ngoại trừ việc tải ảnh đại diện của mọi người.

Bảng điều khiển quản trị là một cửa sổ để vận hành một máy chủ từ Oleafly. Các quản trị viên và người duy trì có thể mở nó. Trong Settings → Collaboration, chọn Open admin console trên thẻ máy chủ, hoặc ở đầu trang Manage server. Mỗi máy chủ có một cửa sổ riêng.

PhầnNội dung hiển thị và thao tác
OverviewMáy chủ có hoạt động tốt hay không, nó có bao nhiêu người, thiết bị và dự án, ai đang trực tuyến, nó dùng bao nhiêu dung lượng, các tùy chọn email và đăng nhập của nó, và các cài đặt của nó trong một cái nhìn tổng quan. Nó cảnh báo Nobody can sign in khi máy chủ không có tùy chọn đăng nhập nào, và The server can’t save files khi thư mục dữ liệu không ghi được.
PeopleMọi người đã đăng nhập. Đổi vai trò, đình chỉ hoặc xóa người, và đăng xuất thiết bị của họ. Các lời mời khách đang chờ phê duyệt nằm ở đầu trang.
Access rulesDanh sách người được cho phép và các quy tắc tên miền.
ProjectsMọi dự án được chia sẻ trên máy chủ, kèm chủ sở hữu, số người, kích thước và hoạt động gần nhất của nó. Tìm theo tiêu đề hoặc chủ sở hữu, chỉ hiện các dự án đang chia sẻ, đã lưu trữ hoặc đang tải lên, và lưu trữ hoặc khôi phục một dự án.
SettingsCác cài đặt máy chủ.
EmailEmail có được thiết lập hay không, địa chỉ From và lần thất bại gần nhất. Gửi một email thử từ đây.
Security logCác lần đăng nhập và đăng nhập bị từ chối, thiết bị, người, cài đặt, dự án và khách. Mỗi mục nêu ai đã làm, khi nào và từ địa chỉ IP nào, kèm chi tiết như dự án, tùy chọn đăng nhập được dùng hoặc lý do một lần đăng nhập bị từ chối.
Connection checksCùng các bước kiểm tra như Test connection, chạy từ máy tính của bạn đến máy chủ.

Người duy trì có thể dùng mọi phần, nhưng họ không thể biến ai thành quản trị viên hoặc người duy trì, xem hay đăng xuất thiết bị của một quản trị viên hoặc người duy trì khác, xem mức dùng dung lượng, lưu trữ hoặc khôi phục dự án, thay đổi cài đặt máy chủ hoặc gửi email thử. Quản trị viên làm được tất cả.

Lưu trữ một dự án sẽ ngừng chia sẻ nó với mọi người. Mọi người ngừng đồng bộ nó và giữ bản sao của riêng mình, còn máy chủ xóa nó sau OLEAFLY_ARCHIVE_DAYS ngày trừ khi một quản trị viên khôi phục nó trước. Khôi phục sẽ chia sẻ lại nó với cùng những người đó. Một dự án chưa từng hoàn tất lần tải lên đầu tiên thì không thể khôi phục. Cả hai đều hiện trong nhật ký bảo mật.

Bảng điều khiển không bao giờ mở một dự án. Nó hiển thị tiêu đề, chủ sở hữu và kích thước, và không có gì bên trong chúng.

Các cài đặt này áp dụng cho mọi người trên máy chủ. Chỉ quản trị viên mới có thể thay đổi chúng.

Cài đặtTác dụng
Allow guestsThành viên có thể mời người từ bên ngoài máy chủ vào các dự án do mình sở hữu.
Approve guests firstMột người duy trì hoặc quản trị viên phê duyệt từng lời mời khách trước khi nó có hiệu lực.
Member directoryCác thành viên có thể tra cứu nhau theo tên khi chia sẻ một dự án.
Show email addresses in the directoryCác thành viên thấy địa chỉ email của nhau khi tra cứu một người nào đó.
Allow link sharingChủ sở hữu dự án có thể cho phép bất kỳ thành viên nào mở một dự án từ liên kết của nó.
Allow public note linksCác thành viên có thể xuất bản một bản sao chỉ đọc của một ghi chú tại một liên kết mà bất kỳ ai cũng mở được mà không cần đăng nhập. Mặc định nó tắt. Tắt nó sẽ dừng mọi liên kết đã xuất bản cho đến khi bạn bật lại. Xem Xuất bản một bản sao chỉ đọc.
Allow project access logsChủ sở hữu dự án có thể giữ một nhật ký về ai đã mở dự án của mình.
Allow commentsMọi người trong các dự án dùng chung có thể bình luận trên văn bản và trả lời. Tắt nó sẽ ẩn bình luận ở mọi nơi và vẫn giữ chúng trong lưu trữ.
Email notificationsTắt nó để dừng email của máy chủ dành cho mọi người, trừ liên kết đăng nhập.
Sign in by emailMọi người có thể đăng nhập bằng một liên kết gửi đến địa chỉ email của họ. Cách này cần cài đặt email của máy chủ.
Xem trước hình ảnh

Không tải được câu trả lời AI

Hãy thử lại, hoặc tìm trong tài liệu.