24 Commits
Author SHA1 Message Date
J Logan 985248cf23 Refine custom init how-to and BUILDING documentation. (#1586)
- Closes #1540.
- Use a published vminit image in the custom init example.
- Refine the integration test example in BUILDING.md to build in an
isolated app-root directory.

## Type of Change
- [ ] Bug fix
- [ ] New feature  
- [ ] Breaking change
- [x] Documentation update

## Motivation and Context
We don't make `latest` tags for vminit images, so the example would
fail.

## Testing
- [ ] Tested locally
- [ ] Added/updated tests
- [x] Added/updated docs
2026-05-22 09:01:00 -07:00
J Logan 5b83b4a9ac Rename config file to config.toml. (#1568)
- Closes #1565.
- `runtime-config.toml` suggested the config
  pertains to just the runtime (managing container
  workloads) aspect of the system.
- Also renames `ADDR` columns to `IP` in 
  `container ls` and `container builder status`.
2026-05-16 08:23:21 -07:00
Noah Thornton e3c49803a0 Move to TOML configuration for defaults (#1425)
- Discussion topic #1336.
- This change migrates away from using `UserDefaults`,
  instead providing a TOML configuration mechanism for
  user configurable settings. All existing system property
  settings keys are supported in the new configuration
  file. However, users will have to migrate any settings
  they have configured in the `UserDefaults` into TOML
  for these settings to take effect.
- Breaking changes:
  * `container system property get` is removed in favor of
    users directly utilizing `container system property list --format toml | jq<>`.
  * `container system property set` is removed since the TOML
    configuration is effectively immutable during the lifetime of the
    `container` daemon. Uses can edit the TOML they have in their home
    directory, however no changes will take effect until the daemon is
    restarted via `container system stop && container system start`
* `container system property list --format table` is removed as
    generating tabular format is non-trivial and the new TOML format is
    intended to be human readable
2026-05-04 12:04:24 -07:00
Saehej Kangandjwhur 2204a9470b [building]: add steps for using container-builder-shim locally (#1279)
- Update build steps for using the `container-builder-shim` locally

---------

Co-authored-by: jwhur <57657645+JaewonHur@users.noreply.github.com>
2026-03-03 08:20:06 -08:00
Manoj Mahapatra ce1b629658 [Docs] Fix typo in BUILDING.md: launchd -> launchctl (#1146)
## Type of Change
- [ ] Bug fix
- [ ] New feature  
- [ ] Breaking change
- [x] Documentation update

## Motivation and Context
The debug instructions in `BUILDING.md` incorrectly reference launchd
list instead of `launchctl` list. `launchd` is the daemon itself and
cannot be invoked directly.

## Testing
- [ ] Tested locally
- [ ] Added/updated tests
- [x] Added/updated docs
2026-02-03 13:43:07 -08:00
Saehej Kang 72f04b6f14 [docs]: update steps on building with containerization project (#1116)
- Closes #1095 
- Just added a few more details about how to build with the local
  `containerization` dependency.
2026-01-30 19:10:03 -08:00
jwhur d762fe55a2 Launch a service with waitForDebugger if specified (#1101)
This PR enables launching a service with `waitForDebugger` flag if the
service label matches a given env variable `CONTAINER_DEBUG`.
2026-01-28 18:22:33 -08:00
c 6244129dc3 Fix grammar in BUILDING.md (#984)
- Fixes a grammar error in the local Containerization development
instructions.
2026-01-26 20:30:45 -08:00
J Logan b1577d8d07 Adds opt-in pre-commit hook for format and header checks. (#1062)
- Closes #639.
- Adds swift format configuration that removes lint checks so we can use
`swift lint` to perform format-only tests.
- Adds `check` target that invokes format and header checks.
- Adds pre-commit script that runs `make check`.
- Adds `pre-commit` target that installs the check script as a
pre-commit hook.

## Type of Change
- [ ] Bug fix
- [x] New feature  
- [ ] Breaking change
- [x] Documentation update

## Motivation and Context
Avoids wasting time and commit rewrites.

## Testing
- [x] Tested locally
- [ ] Added/updated tests
- [x] Added/updated docs
2026-01-16 15:50:47 -08:00
J Logan 21facf00a8 Add instructions for using locally built init filesystem. (#1032)
- Closes #1030.
2026-01-08 17:02:22 -08:00
J Logan ffc1195556 Remove references to macOS 26 beta. (#702)
## Type of Change
- [ ] Bug fix
- [ ] New feature  
- [ ] Breaking change
- [x] Documentation update
2025-10-01 15:27:35 -07:00
Jacob Ford fe72d7ba41 Docs: clarify Xcode 26 beta must be the active developer directory (#238)
And add instructions for setting it so

Related: https://github.com/apple/containerization/issues/66
2025-08-18 12:11:54 -04:00
Justin Yao Du 728527b8ba Explain how to install a release build in BUILDING.md (#379)
When users run commands with a debug build, they see a warning that
debug builds may have worse performance. Add instructions to BUILDING.md
so that users who wish to install from source know how to get a release
build.

I tested the command locally and ran `container --version` to verify
that I got a release build.
2025-07-29 19:11:06 -07:00
Typ0genius e09e932efa fix typo in local package path for building (#327) 2025-07-11 12:02:03 -07:00
J Logan 7272328cf3 Use swift package edit instead of CONTAINERIZATION_PATH. (#318)
- Closes #294.
2025-07-09 14:06:28 -07:00
Dmitry Kovba 009ce93b4a Require having a Mac with Apple silicon and Xcode 26 beta (#125)
This PR requires installing Xcode 26 beta until we resolve
https://github.com/apple/containerization/issues/66.
2025-06-16 12:35:14 -07:00
Dmitry Kovba 05798f38a1 Update the names of Xcode and macOS (#123)
This PR updates the names of Xcode and macOS to the official names used
in https://developer.apple.com/download/applications/.
2025-06-13 16:58:28 -07:00
owenarthur f1e9f0143c Clean up typos in docs, fix reference to default subnet (#71) 2025-06-09 17:40:27 -07:00
J LoganandAditya Ramani fc13f55b23 Fine-tune build requirements. (#52)
Co-authored-by: Aditya Ramani <a_ramani@apple.com>
2025-06-09 11:21:40 -07:00
Madhu Venugopalandmadhu e933ff3c53 Updating latest macOS and Xcode versions (#49)
Co-authored-by: madhu <mvenugopal@apple.com>
2025-06-09 10:33:51 -07:00
Eric Ernst 1ef655eb96 docs: improve instructions for building with local containerization (#43)
If they're just pulling containerization, suggest following build env
setup directions from containerization repo so they get a cross-platform
SDK setup.
2025-06-08 22:33:55 -07:00
Eric Ernst 8fcbd01678 docs: update version description (#42)
Updating version descriptions so we're consistent across repos.

Signed-off-by: Eric Ernst <eric_ernst@apple.com>
2025-06-08 18:02:44 -07:00
J Logan 6690f6d076 Corrections and refinements for user documentation. (#35) 2025-06-07 21:00:47 -07:00
J Logan 94e06e28a0 Refine user documentation. (#24)
- Extract README sections into BUILDING and CONTRIBUTING documents. This
should work better than sections in README as it keeps the README short,
and the BUILDING and CONTRIBUTING files will stand out in the file list.
- Merged localdev document into BUILDING.
- Fixed broken links.
- Changed DNS setup so later DNS-dependent steps should work.
- Added h1 and link to SECURITY document.
2025-06-05 18:50:40 -07:00