From fd06cd76218720ace82c4111e24514ff95a60abd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Roth?= Date: Sat, 11 Jan 2025 11:19:43 +0100 Subject: [PATCH] update README --- Makefile | 4 +-- README.rst | 80 ++++++++++++++++++++++++++++++++---------------------- 2 files changed, 49 insertions(+), 35 deletions(-) diff --git a/Makefile b/Makefile index d6a81da49..680c738c9 100644 --- a/Makefile +++ b/Makefile @@ -140,7 +140,7 @@ dpkg: prepare swagger ## Build debian packages mkdir -p build && mv ../*.deb build/ ; \ cd build && ls -l *.deb -binaries: prepare swagger ## Build binary releases (FreeBSD, MacOS, Linux tar) +binaries: prepare swagger ## Build binary releases (FreeBSD, macOS, Linux generic) # build aptly GOOS=$(GOOS) GOARCH=$(GOARCH) go build -o build/tmp/aptly -ldflags='-extldflags=-static' # install @@ -195,7 +195,7 @@ docker-serve: ## Run development server (auto recompiling) on http://localhost: docker-lint: ## Run golangci-lint in docker container @docker run -it --rm -v ${PWD}:/work/src aptly-dev /work/src/system/docker-wrapper lint -docker-binaries: ## Build binary releases (FreeBSD, MacOS, Linux tar) in docker container +docker-binaries: ## Build binary releases (FreeBSD, macOS, Linux generic) in docker container @docker run -it --rm -v ${PWD}:/work/src aptly-dev /work/src/system/docker-wrapper binaries docker-man: ## Create man page in docker container diff --git a/README.rst b/README.rst index a53990db6..a27ed5539 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,3 @@ -===== -aptly -===== - .. image:: https://github.com/aptly-dev/aptly/actions/workflows/ci.yml/badge.svg :target: https://github.com/aptly-dev/aptly/actions @@ -14,15 +10,18 @@ aptly .. image:: https://goreportcard.com/badge/github.com/aptly-dev/aptly :target: https://goreportcard.com/report/aptly-dev/aptly +aptly +===== + Aptly is a swiss army knife for Debian repository management. .. image:: http://www.aptly.info/img/aptly_logo.png :target: http://www.aptly.info/ Documentation is available at `http://www.aptly.info/ `_. For support please use -mailing list `aptly-discuss `_. +open `issues ` or `discussions `. -Aptly features: ("+" means planned features) +Aptly features: * make mirrors of remote Debian/Ubuntu repositories, limiting by components/architectures * take snapshots of mirrors at any point in time, fixing state of repository at some moment of time @@ -32,48 +31,49 @@ Aptly features: ("+" means planned features) * filter repository by search query, pulling dependencies when required * publish self-made packages as Debian repositories * REST API for remote access -* mirror repositories "as-is" (without resigning with user's key) (+) -* support for yum repositories (+) -Current limitations: -* translations are not supported yet +Installation +============= -Install Stable Version ------------------------ +Aptly can be installed on several operating systems and is available in the official Debian and Ubuntu distributions: -To install aptly on Debian/Ubuntu, add new repository to ``/etc/apt/sources.list``:: +Debian Packages +---------------- - deb http://repo.aptly.info/ squeeze main +Aptly is provided in the following debian packages: +- aptly (main binary) +- aptly-api (systemd service for REST API) +- aptly-dbgsym (debugging symbols) -And import key that is used to sign the release:: +The packages can be installed on official `Debian `_ and `Ubuntu `_ distributions. - $ apt-key adv --keyserver keyserver.ubuntu.com --recv-keys EE727D4449467F0E +Upstream Debian Packages +------------------------- -After that you can install aptly as any other software package:: +If a newer version (not available in Debian/Ubuntu) of aptly is required, upstream debian packages (built from git tags) can be installed as follows: - $ apt-get update - $ apt-get install aptly +Install the following APT key:: -Don't worry about squeeze part in repo name: aptly package should work on Debian squeeze+, -Ubuntu 10.0+. Package contains aptly binary, man page and bash completion. + sudo wget -O /etc/apt/keyrings/aptly.asc https://www.aptly.info/pubkey.txt -Other Binaries -~~~~~~~~~~~~~~~~~ +Define Release APT sources in ``/etc/apt/sources.list.d/aptly.list``:: -Binary executables (depends almost only on libc) are available for download from `GitHub Releases `_. + deb [signed-by=/etc/apt/keyrings/aptly.asc] http://repo.aptly.info/release DIST main -Install CI Version --------------------- +Where DIST is one of: ``buster``, ``bullseye``, ``bookworm``, ``focal``, ``jammy``, ``noble`` -More recent versions are available as CI builds (development, might be unstable). +Install aptly packages: -Debian GNU/Linux -~~~~~~~~~~~~~~~~~ + $ apt-get update + $ apt-get install aptly + $ apt-get install aptly-api # REST API systemd service -Install the following APT key:: +CI Builds +~~~~~~~~~~ - sudo wget -O /etc/apt/keyrings/aptly.asc https://www.aptly.info/pubkey.txt +For testing new features or bugfixes, recent builds are available as CI builds (built from master, might be unstable) and can be installed as follows: +install CI builds as follows: Define CI APT sources in ``/etc/apt/sources.list.d/aptly-ci.list``:: @@ -81,13 +81,23 @@ Define CI APT sources in ``/etc/apt/sources.list.d/aptly-ci.list``:: Where DIST is one of: ``buster``, ``bullseye``, ``bookworm``, ``focal``, ``jammy``, ``noble`` +Note: same gpg key is used as for the Upstream Debian Packages. + +Other Operating Systems +------------------------ + +Binary executables (depends almost only on libc) are available on `GitHub Releases `_ for: +- macOS / darwin (amd64, arm64) +- FreeBSD (amd64, arm64, 386, arm) +- Generic Linux (amd64, arm64, 386, arm) + Contributing ------------- +============= Please follow detailed documentation in `CONTRIBUTING.md `_. Integrations ------------- +============= Vagrant: @@ -124,3 +134,7 @@ GUI for aptly API: Scala sbt: - `sbt aptly plugin `_ by Arup Malakar + +Molior: + +- `Molior Debian Build System `_ by André Roth