diff --git a/README.md b/README.md index f3b3354..df42599 100644 --- a/README.md +++ b/README.md @@ -26,20 +26,60 @@ The source archives used to build this repository history can be found here: As described in the old project documentation, MARS_NWE is a functional clone of a NetWare server for Linux. It works with the usual DOS client software normally used with classic NetWare servers. It provides file, bindery, and print services for NetWare client software, and it does not impose user license restrictions. It also includes a RIP/SAP daemon that can turn a Linux machine into an IPX router. -The wider MARS_NWE ecosystem also includes related tools and companion projects: +## MARS_NWE Ecosystem and Submodules -- **SMArT**: the web configuration tool for MARS_NWE. - - -- **dosutils**: DOS-side helper tools for login, mapping, testing, and related client tasks. - - -- **mailutils**: additional mail-related tools and utilities for MARS_NWE environments. - - -- **ncpfs module**: a standalone NCPFS kernel module for Linux 4.18 and newer. - - -- **ipx kernel module**: IPX kernel support for Linux 4.18 and newer. - - -- **ipx-utils**: userspace IPX utilities for Linux. - - +The wider MARS_NWE ecosystem consists of several companion repositories that are typically used together. While they are linked here, **each project has its own README with important details**, especially regarding configuration and usage. + +- **SMArT (Web Administration Interface)** + + Provides a web-based configuration and management interface for MARS_NWE. + + ⚠️ **Important:** + The SMArT repository mainly documents usage of the web interface itself. Parts of its configuration are described in the README files of related submodules, especially: + - `mars-mail` + - `mars-dosutils` + + This split can be confusing at first — make sure to check those repositories as well when setting up SMArT. + +- **dosutils (DOS Client Utilities)** + + Collection of DOS-side helper tools for login, drive mapping, testing, and general NetWare client interaction. + + The README in this repository explains: + - available tools + - usage on DOS clients + - integration into SYS:PUBLIC + +- **mailutils (Mail Integration Tools)** + + Additional utilities related to mail handling in a MARS_NWE environment. + + The README includes: + - configuration relevant for mail handling + - parts of the setup that are also required when using SMArT + +- **ncpfs module** + + Standalone NCPFS kernel module for Linux 4.18 and newer. + +- **ipx kernel module** + + IPX kernel support for Linux 4.18 and newer. + +- **ipx-utils** + + Userspace IPX utilities for Linux. + +## Notes on Documentation Structure + +Due to the historical growth of the project, documentation is distributed across multiple repositories: + +- The main repository documents the core server +- `mars-smart` documents the web interface +- `mars-mail` and `mars-dosutils` contain important configuration and operational details +- Some setup steps (especially for SMArT) require reading multiple READMEs + +If something seems incomplete in one repository, check the others — this is expected for now. ## SMArT @@ -91,17 +131,6 @@ At minimum, you should: The comments in the configuration file are worth reading carefully, as there may be additional settings you want to customize for your environment. -You will probably also want to edit: - -`/var/mars_nwe/SYS/public/net$log.dat` - -and replace the default login script with something more useful, for example: - -```txt -MAP INS S1:=SYS:PUBLIC -MAP *1:=SYS: -``` - ## Running On current systems, MARS_NWE should normally be managed through the installed systemd service files. @@ -118,19 +147,13 @@ To start the HTTPS-enabled web UI daemon: sudo systemctl enable --now mars-nwe-webui.service ``` -The runtime directory setup is handled by the service files, so the old manual `mkdir` steps are no longer needed when using systemd. - -For Gentoo and other OpenRC-based setups, init.d files are available in the `doc` directory and currently need to be installed manually. - ## Clients You will also need a NetWare client. -For DOS and Windows 3.11, one of the best choices is probably **Client32 v2.71** from February 1999. +For DOS and Windows 3.11, one of the best choices is probably Client32 v2.71 from February 1999. -- - -According to the original notes, it uses at most 4K of conventional memory, although it requires a 386SX or better CPU and a few megabytes of extended memory. +- For other operating systems, or for older DOS machines, additional client software can be found here: @@ -138,49 +161,12 @@ For other operating systems, or for older DOS machines, additional client softwa MARS_NWE does **not** work with the classic Mac client, because that client requires NDS from NetWare 4.x or newer, which MARS_NWE does not implement. -## NetWare DOS and OS/2 Utilities - -MARS_NWE itself only includes the bare minimum needed to log in and map drives on DOS. If you want additional tools such as `flag` or `ncopy`, you can use the **NetWare DOS Client Kit v3.01** from 1990, which Novell later made freely available. The original README points to the following page and notes `DSWIN3.ZIP` and `DSWIN4.ZIP` as useful archives: - -- - -These DOS utilities would normally live in: - -`/var/mars_nwe/SYS/public/` - -For OS/2, some client kits include updated 16-bit OS/2 utilities, usually on the `OS2UTIL` disks, which can help fill some of the gaps. The four executables `attach`, `login`, `map`, and `slist` should go in: - -`/var/mars_nwe/SYS/login/OS2/` - -The remaining OS/2 utilities should go in: - -`/var/mars_nwe/SYS/public/OS2/` - -For other tools such as **SYSCON**, you may still need an original copy of NetWare 3.11 or 3.12. - -## Managing Users and Login Scripts - -For NetWare 3.x style servers, user and login script management would normally be done with the DOS **SYSCON** utility. MARS_NWE does not include a replacement for that tool, and the original Novell version is likely out of bounds unless you already hold a valid NetWare 3 license. - -One possible alternative is **WnSyscon**, a 16-bit Windows SYSCON replacement: - -- - -According to the old README, Novell bundled the registered version with NetWare 3.2 as their Graphical SYSCON Utility - - - - - and the shareware version could be downloaded from: - -- - -The shareware version was described as being fully functional aside from a few nag screens. Unfortunately, obtaining a properly registered version today may require owning a legitimate NetWare 3.2 copy, unless the original author can still be contacted somehow. - ## Where To Get Help -There is some very old documentation in the `doc` directory that may still be useful. The old linware mailing list archives may also contain useful information, and the original README also links to a set of additional notes here: +There is some very old documentation in the `doc` directory that may still be useful. The old linware mailing list archives may also contain useful information: - - If none of those help, the remaining option is often the same as it has always been for old infrastructure software: read the code. +