-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
62 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# About Netatalk | ||
[![Build Status](https://github.com/Netatalk/netatalk/actions/workflows/build.yml/badge.svg)](https://github.com/Netatalk/netatalk/actions/workflows/build.yml) | ||
[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) | ||
[<img src="https://sonarcloud.io/images/project_badges/sonarcloud-orange.svg" height="20" />](https://sonarcloud.io/summary/overall?id=Netatalk_netatalk&branch=branch-netatalk-2-3) | ||
|
||
Netatalk is a freely-available Open Source fileserver that implements the Apple Filing Protocol (AFP) 3.3 over TCP/IP and AppleTalk. | ||
AFP was the primary file sharing protocol for Apple Macintosh and Apple II computers from 1987 to 2013. | ||
A *NIX/*BSD system running Netatalk is capable of serving many Macintosh clients simultaneously as an AppleShare file server. | ||
|
||
# Why Should I Use Netatalk? | ||
If you're running a network of older Macs, in particular those running OS X 10.8 Mountain Lion or earlier, all the way back to Classic Mac OS, | ||
are well served by running a Netatalk AppleShare server. The latest macOS at the time of writing (macOS 13 Ventura) still comes with an AFP client, | ||
so Netatalk can act as a seamless bridge between new and old Macs. | ||
|
||
Compared to other Open Source file sharing solutions such as NFS or Samba, Netatalk delivers high transfer speeds and full integration | ||
of Classic Mac OS metadata (resource forks) as well as user authentication methods (UAMs) compatible with Classic Mac OS clients that don't support modern cryptography. | ||
|
||
Modern AFP features such as Bonjour, and Time Machine are also supported. | ||
|
||
# AppleTalk | ||
Netatalk v2 supports the legacy AppleTalk protocol, which means it can act as a bridge between older Macs, networked Apple IIs, and the very latest macOS systems. It is AFP 3.3 compliant with AFP 2 backwards compatibility. | ||
|
||
The included print server daemon can provide Apple II and Macintosh clients with the ability to print to AppleTalk-only printers. In addition, Netatalk is fully integrated with CUPS, allowing any networked Mac to discover and print to a CUPS/AirPrint compatible printer on the network. | ||
|
||
Additionally, Netatalk can be used to act as an AppleTalk router, providing both segmentation and zone names in traditional Macintosh networks. | ||
|
||
# Contributions | ||
Bug reports and feature requests can be filed as GitHub issue ticket: | ||
|
||
https://github.com/Netatalk/netatalk/issues | ||
|
||
Before contributing code to the project, please read the guidelines in the wiki on how to prepare a PR that is likely to be accepted by the maintainers: | ||
|
||
https://github.com/Netatalk/netatalk/wiki/Developer-Notes | ||
|
||
PRs are automatically picked up by GitHub CI, which runs the builds, integration tests, as well as static analysis scan on SonarCloud. | ||
|
||
# Documentation | ||
The latest version of the Netatalk manual can be found at: | ||
|
||
https://netatalk.sourceforge.io/2.2/htmldocs/ | ||
|
||
Each Netatalk component also has a *NIX man page which can be accessed on the command line, f.e. `man afpd`. | ||
|
||
# Wiki | ||
Collaborative articles can be found on the Netatalk wiki hosted on GitHub. | ||
|
||
Please feel free to edit existing and create new articles. | ||
|
||
https://github.com/Netatalk/netatalk/wiki | ||
|
||
# Mailing Lists | ||
Netatalk contributors and maintainers interact with each other primarily on the netatalk-admins and netatalk-devel mailing list. | ||
|
||
Subscribe and participate, or read archived discussion threads at: | ||
|
||
https://sourceforge.net/p/netatalk/mailman/ | ||
|
||
# Website | ||
The Netatalk website is where new releases and other news about the project are posted. | ||
|
||
https://netatalk.sourceforge.io |