Skip to content

Commit a8e0e3d

Browse files
committed
update README
1 parent 73695af commit a8e0e3d

File tree

2 files changed

+49
-37
lines changed

2 files changed

+49
-37
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ dpkg: prepare swagger ## Build debian packages
140140
mkdir -p build && mv ../*.deb build/ ; \
141141
cd build && ls -l *.deb
142142

143-
binaries: prepare swagger ## Build binary releases (FreeBSD, MacOS, Linux tar)
143+
binaries: prepare swagger ## Build binary releases (FreeBSD, macOS, Linux generic)
144144
# build aptly
145145
GOOS=$(GOOS) GOARCH=$(GOARCH) go build -o build/tmp/aptly -ldflags='-extldflags=-static'
146146
# install
@@ -195,7 +195,7 @@ docker-serve: ## Run development server (auto recompiling) on http://localhost:
195195
docker-lint: ## Run golangci-lint in docker container
196196
@docker run -it --rm -v ${PWD}:/work/src aptly-dev /work/src/system/docker-wrapper lint
197197

198-
docker-binaries: ## Build binary releases (FreeBSD, MacOS, Linux tar) in docker container
198+
docker-binaries: ## Build binary releases (FreeBSD, macOS, Linux generic) in docker container
199199
@docker run -it --rm -v ${PWD}:/work/src aptly-dev /work/src/system/docker-wrapper binaries
200200

201201
docker-man: ## Create man page in docker container

README.rst

Lines changed: 47 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
=====
2-
aptly
3-
=====
4-
51
.. image:: https://github.com/aptly-dev/aptly/actions/workflows/ci.yml/badge.svg
62
:target: https://github.com/aptly-dev/aptly/actions
73

@@ -14,15 +10,18 @@ aptly
1410
.. image:: https://goreportcard.com/badge/github.com/aptly-dev/aptly
1511
:target: https://goreportcard.com/report/aptly-dev/aptly
1612

13+
aptly
14+
=====
15+
1716
Aptly is a swiss army knife for Debian repository management.
1817

1918
.. image:: http://www.aptly.info/img/aptly_logo.png
2019
:target: http://www.aptly.info/
2120

2221
Documentation is available at `http://www.aptly.info/ <http://www.aptly.info/>`_. For support please use
23-
mailing list `aptly-discuss <https://groups.google.com/forum/#!forum/aptly-discuss>`_.
22+
open `issues <https://github.com/aptly-dev/aptly/issues>`_ or `discussions <https://github.com/aptly-dev/aptly/discussions>`_.
2423

25-
Aptly features: ("+" means planned features)
24+
Aptly features:
2625

2726
* make mirrors of remote Debian/Ubuntu repositories, limiting by components/architectures
2827
* take snapshots of mirrors at any point in time, fixing state of repository at some moment of time
@@ -32,62 +31,71 @@ Aptly features: ("+" means planned features)
3231
* filter repository by search query, pulling dependencies when required
3332
* publish self-made packages as Debian repositories
3433
* REST API for remote access
35-
* mirror repositories "as-is" (without resigning with user's key) (+)
36-
* support for yum repositories (+)
3734

38-
Current limitations:
35+
Any contributions are welcome! Please see `CONTRIBUTING.md <CONTRIBUTING.md>`_.
3936

40-
* translations are not supported yet
37+
Installation
38+
=============
4139

42-
Install Stable Version
43-
-----------------------
40+
Aptly can be installed on several operating systems.
4441

45-
To install aptly on Debian/Ubuntu, add new repository to ``/etc/apt/sources.list``::
42+
Debian / Ubuntu
43+
----------------
4644

47-
deb http://repo.aptly.info/ squeeze main
45+
Aptly is provided in the following debian packages:
4846

49-
And import key that is used to sign the release::
47+
* aptly (main binary)
48+
* aptly-api (systemd service for REST API)
49+
* aptly-dbgsym (debugging symbols)
5050

51-
$ apt-key adv --keyserver keyserver.ubuntu.com --recv-keys EE727D4449467F0E
51+
The packages can be installed on official `Debian <https://packages.debian.org/search?keywords=aptly>`_ and `Ubuntu <https://packages.ubuntu.com/search?keywords=aptly>`_ distributions.
5252

53-
After that you can install aptly as any other software package::
53+
Upstream Debian Packages
54+
~~~~~~~~~~~~~~~~~~~~~~~~~
5455

55-
$ apt-get update
56-
$ apt-get install aptly
56+
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:
5757

58-
Don't worry about squeeze part in repo name: aptly package should work on Debian squeeze+,
59-
Ubuntu 10.0+. Package contains aptly binary, man page and bash completion.
58+
Install the following APT key (as root)::
6059

61-
Other Binaries
62-
~~~~~~~~~~~~~~~~~
60+
wget -O /etc/apt/keyrings/aptly.asc https://www.aptly.info/pubkey.txt
6361

64-
Binary executables (depends almost only on libc) are available for download from `GitHub Releases <https://github.com/aptly-dev/aptly/releases>`_.
62+
Define Release APT sources in ``/etc/apt/sources.list.d/aptly.list``::
6563

66-
Install CI Version
67-
--------------------
64+
deb [signed-by=/etc/apt/keyrings/aptly.asc] http://repo.aptly.info/release DIST main
6865

69-
More recent versions are available as CI builds (development, might be unstable).
66+
Where DIST is one of: ``buster``, ``bullseye``, ``bookworm``, ``focal``, ``jammy``, ``noble``
67+
68+
Install aptly packages::
7069

71-
Debian GNU/Linux
72-
~~~~~~~~~~~~~~~~~
70+
apt-get update
71+
apt-get install aptly
72+
apt-get install aptly-api # REST API systemd service
7373

74-
Install the following APT key::
74+
CI Builds
75+
~~~~~~~~~~
7576

76-
sudo wget -O /etc/apt/keyrings/aptly.asc https://www.aptly.info/pubkey.txt
77+
For testing new features or bugfixes, recent builds are available as CI builds (built from master, may be unstable!) and can be installed as follows:
78+
install CI builds as follows:
7779

7880
Define CI APT sources in ``/etc/apt/sources.list.d/aptly-ci.list``::
7981

8082
deb [signed-by=/etc/apt/keyrings/aptly.asc] http://repo.aptly.info/ci DIST main
8183

8284
Where DIST is one of: ``buster``, ``bullseye``, ``bookworm``, ``focal``, ``jammy``, ``noble``
8385

84-
Contributing
85-
------------
86+
Note: same gpg key is used as for the Upstream Debian Packages.
87+
88+
Other Operating Systems
89+
------------------------
8690

87-
Please follow detailed documentation in `CONTRIBUTING.md <CONTRIBUTING.md>`_.
91+
Binary executables (depends almost only on libc) are available on `GitHub Releases <https://github.com/aptly-dev/aptly/releases>`_ for:
92+
93+
- macOS / darwin (amd64, arm64)
94+
- FreeBSD (amd64, arm64, 386, arm)
95+
- Generic Linux (amd64, arm64, 386, arm)
8896

8997
Integrations
90-
------------
98+
=============
9199

92100
Vagrant:
93101

@@ -124,3 +132,7 @@ GUI for aptly API:
124132
Scala sbt:
125133

126134
- `sbt aptly plugin <https://github.com/amalakar/sbt-aptly>`_ by Arup Malakar
135+
136+
Molior:
137+
138+
- `Molior Debian Build System <https://github.com/molior-dbs/molior>`_ by André Roth

0 commit comments

Comments
 (0)