blob: b2b35845bcf157a255147812c9feb666ca2cd220 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
# Ceres - Recipe server for your favorite dishes
With Ceres you can run a recipe server in your home network. Have a look at the
[project page][1] for more details.
All notable changes are documented in the [changelog][2].
## Expected environment and dependencies
Ceres should run on every Linux distribution. If it does not run on your Linux
distribution, please contact me and we will see what we can do.
Please install the following dependencies to build and run Ceres:
- [GNU Coreutils][4]
- [Git][5]
- [Make][6]
- [Go][7]
- [MariaDB][3]
## Setup Ceres database
Ceres supports only the [MariaDB][3] SQL implementation which is available on a
lot of Linux distributions.
Database creation should be easy so please install MariaDB on your system and
then just run the first migration script with root user rights like this:
```
mariadb -u root < sql/0001_migration.sql
```
After database creation you have to also grant access to the database for a
Linux user. See the next section for details.
## Grant access to Ceres database for a Linux user
If you want to use Ceres for production it is recommended to add a Linux user
for this purpose like this:
```
useradd ceres
```
For development you can just go on with your default Linux username. First
start an interactive MariaDB shell like this:
```
mariadb -u root
```
And then add a corresponding MariaDB user for the selected Linux user and set
corresponding access rights (substitute <user> with the selected username):
```
CREATE USER IF NOT EXISTS '<user>'@'localhost' IDENTIFIED VIA unix_socket;
GRANT ALL PRIVILEGES on ceres.* to '<user>'@'localhost';
FLUSH PRIVILEGES;
```
The `unix_socket` authentication method ensures that the corresponding user
does not need to provide a password.
Finally you can quit the MariaDB shell with CTRL + d.
## Build and run Ceres
If you just cloned the repository it is important to initialize Git submodules
to add dependencies via `git submodule update --init`.
Then it is time to build and run Ceres for the first time! If your database is
correctly configured and your current user has access rights, it is very simple
to run the server in debug mode:
```
make debug
```
In addition you can also build the server executable with `make all`. The
result is in the build folder and can be run with:
```
./build/ceres -c config/debug.json
```
The used `config/debug.json` config file is only for debugging. If you want to
run it as a server, have a look at the `config/default.json` file.
## Packaging and Installation
If you want to package Ceres for a Linux distribution, feel free to use the
Make target for installation. Use it for example with a fakeroot:
```
mkdir fakeroot
make DESTDIR=fakeroot install
tree fakeroot
```
Please add a service unit for the init system of your distribution.
If you want to install Ceres to your system, it is recommended to first do the
packaging. One reason is that there is no uninstall Make target. This would
have to be tested and package managers are way better in cleanly remove stuff
from your system.
If you insist to install it without an uninstall option, run `make install`
with root rights and write a service unit or something else to run the
executable at boot.
[1]: https://xengineering.eu/git/ceres
[2]: ./CHANGELOG.md
[3]: https://mariadb.com/
[4]: https://www.gnu.org/software/coreutils/
[5]: https://git-scm.com/
[6]: https://www.gnu.org/software/make/
[7]: https://go.dev/
|
