proxmox-backup

Go to file

Fabian Ebner 58fcbf5ab7 client: expose all-file-systems option Useful to avoid the need for a long (and possibly changing) list of include-dev options in certain situations, e.g. nested ZFS file systems. The option is already implemented and seems to work as expected. The checks for virtual filesystems are not affected by this option. Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>		2020-11-16 16:59:14 +01:00
.cargo	cargo: switch to use packaged crates by default	2020-01-03 09:40:33 +01:00
debian	ui: tell ESLint to be strict in check target	2020-11-12 09:54:39 +01:00
docs	docs: faq: fix first releases	2020-11-11 10:14:01 +01:00
etc	docs: update package repositories	2020-11-10 13:14:04 +01:00
examples	client/remote: allow using ApiToken + secret	2020-10-29 15:14:27 +01:00
src	client: expose all-file-systems option	2020-11-16 16:59:14 +01:00
tests	server: use generalized commando socket for worker tasks commands	2020-11-02 19:48:04 +01:00
www	ui: datastores: hide "no datastore" box by default	2020-11-16 16:59:14 +01:00
zsh-completions	Add zsh completion scripts	2020-02-27 06:50:14 +01:00
.gitignore	.gitignore: add build directory	2020-07-22 09:19:29 +02:00
Cargo.toml	use pin-project to remove more unsafe blocks	2020-11-12 09:43:38 +01:00
defines.mk	Add zsh completion scripts	2020-02-27 06:50:14 +01:00
Makefile	add daily update and maintenance task	2020-10-31 22:51:26 +01:00
README.rst	readme: allow to directly copy+paste+execute commands	2020-10-12 13:36:34 +02:00
rustfmt.toml	import rustfmt.toml	2019-08-22 13:44:57 +02:00
TODO.rst	[chore] bump to using pxar 0.2.0	2020-06-25 09:46:56 +02:00

README.rst

``rustup`` Toolchain
====================

We normally want to build with the ``rustc`` Debian package. To do that
you can set the following ``rustup`` configuration:

    # rustup toolchain link system /usr
    # rustup default system


Versioning of proxmox helper crates
===================================

To use current git master code of the proxmox* helper crates, add::

   git = "git://git.proxmox.com/git/proxmox"

or::

   path = "../proxmox/proxmox"

to the proxmox dependency, and update the version to reflect the current,
pre-release version number (e.g., "0.1.1-dev.1" instead of "0.1.0").


Local cargo config
==================

This repository ships with a ``.cargo/config`` that replaces the crates.io
registry with packaged crates located in ``/usr/share/cargo/registry``.

A similar config is also applied building with dh_cargo. Cargo.lock needs to be
deleted when switching between packaged crates and crates.io, since the
checksums are not compatible.

To reference new dependencies (or updated versions) that are not yet packaged,
the dependency needs to point directly to a path or git source (e.g., see
example for proxmox crate above).


Build
=====
on Debian Buster

Setup:
  1. # echo 'deb http://download.proxmox.com/debian/devel/ buster main' >> /etc/apt/sources.list.d/proxmox-devel.list
  2. # sudo wget http://download.proxmox.com/debian/proxmox-ve-release-6.x.gpg -O /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
  3. # sudo apt update
  4. # sudo apt install devscripts debcargo clang
  5. # git clone git://git.proxmox.com/git/proxmox-backup.git
  6. # sudo mk-build-deps -ir

Note: 2. may be skipped if you already added the PVE or PBS package repository

You are now able to build using the Makefile or cargo itself.