You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Align multiline method call arguments and method declaration parameters
30
34
- New line after a colon
31
35
- Align multiline import statements
@@ -41,16 +45,19 @@ I use PyCharm for all of my programming, and these are what I use for my setting
41
45
- 1 line before and after `while` loops
42
46
- Run isort on `import` statements, including `from imports`.
43
47
- Keep `from imports` within their own group:
44
-
```
48
+
49
+
```python
45
50
import bar
46
51
import foo
47
52
48
53
from baz import foo
49
54
from foobar import morefoo
50
55
```
56
+
51
57
- Join `from imports` with the same source
52
58
- Align dictionaries on colons:
53
-
```
59
+
60
+
```python
54
61
x =max(
55
62
1,
56
63
2,
@@ -61,8 +68,9 @@ x = max(
61
68
"eggs and ham": -0.0e0
62
69
}
63
70
```
71
+
64
72
- Add a linefeed at the end of the file
65
73
66
-
####Documentation for Read The Docs
67
-
-----
68
-
If you wish to update some of our [documentation](http://iocage.readthedocs.org), you only need to submit a PR for the files you change in iocage/doc/source. They will automatically be updated when the changes are merged.
74
+
##Documentation for Read The Docs
75
+
76
+
If you wish to update some of our [documentation](http://iocage.readthedocs.org), you only need to submit a PR for the files you change in iocage/doc/source. They will automatically be updated when the changes are merged.
Copy file name to clipboardexpand all lines: README.md
+39-26
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
-
iocage
2
-
======
1
+
# iocage
3
2
4
3
[](http://isitmaintained.com/project/iocage/iocage"Average time to resolve an issue")
5
4
[](http://isitmaintained.com/project/iocage/iocage"Percentage of issues still open")
To install subsequent updates: run `make install` as root.
30
31
31
-
##### Ports:
32
+
### Ports:
33
+
32
34
- Build the port as follows: `cd /usr/ports/sysutils/py3-iocage/ ; make install clean`
33
35
34
36
*Note: `sysutils/py3-iocage` will conflict with other previous versions of iocage included into the ports tree. We suggest you first uninstall any other previous version of iocage prior to install this one.*
35
37
36
-
##### Pkg:
38
+
### Pkg:
39
+
37
40
- It is possible to install pre-built packages using pkg(8) if you are using FreeBSD 10 or above: `pkg install py36-iocage`
38
41
39
-
######Upgrading from `iocage_legacy`:
42
+
#### Upgrading from `iocage_legacy`:
40
43
41
44
This repository replaces `iocage_legacy`. To upgrade to the current version:
42
45
43
46
1. Stop the jails (`service iocage stop; iocage stop ALL`)
44
-
2. Back up your data
45
-
3. Remove the old `iocage` package if it is installed (`pkg delete iocage`)
46
-
4. Install `py3-iocage` using one of the methods above
47
-
5. Migrate the jails. This can be done by running `iocage list` as root
48
-
6. Start the jails (`service iocage onestart`)
47
+
1. Back up your data
48
+
1. Remove the old `iocage` package if it is installed (`pkg delete iocage`)
49
+
1. Install `py3-iocage` using one of the methods above
50
+
1. Migrate the jails. This can be done by running `iocage list` as root
51
+
1. Start the jails (`service iocage onestart`)
49
52
50
53
## WARNING:
54
+
51
55
- This is beta quality software, there be dragons! Please report them.
52
56
- Some features of the previous iocage_legacy are either being dropped or simply not ported yet, feel free to open an issue asking about your favorite feature. But please search before opening a new one. PR's welcome for any feature you want!
We _like_ issues! If you are having trouble with `iocage` please open a GitHub [issue](https://github.com/iocage/iocage/issues) and we will ~~run around with our hair on fire~~ look into it. Before doing so, please give us some information about the situation:
63
+
59
64
- Tell us what version of FreeBSD you are using with something like `uname -ro`
60
65
- It would also be helpful if you gave us the output of `iocage --version`
61
66
- Most importantly, try to be detailed. Simply stating "I tried consoling into a jail and it broke" will not help us very much.
62
67
- Use the [Markdown Basics](https://help.github.com/articles/markdown-basics/#code-formatting) GitHub page for more information on how to paste lines of code and terminal output.
63
68
64
-
#### Submitting a pull request:
69
+
## Submitting a pull request:
70
+
65
71
Please be detailed on the exact use case of your change and a short demo of
66
72
it. Make sure it conforms with PEP-8 and that you supply a test with it if
67
73
relevant. Lines may not be longer then 80 characters.
68
74
69
-
**FEATURES:**
75
+
## FEATURES
76
+
70
77
- Ease of use
71
78
- Rapid jail creation within seconds
72
79
- Automatic package installation
@@ -76,8 +83,9 @@ relevant. Lines may not be longer then 80 characters.
76
83
- Export and import
77
84
- And many more!
78
85
79
-
---
80
-
**QUICK HOWTO:**
86
+
----
87
+
88
+
## QUICK HOWTO
81
89
82
90
Activate a zpool:
83
91
@@ -108,27 +116,32 @@ spot to begin configuration of your jail.
108
116
109
117
To see a list of commands available to you now, type `iocage` outside the jail.
110
118
111
-
------
119
+
----
120
+
121
+
### REQUIREMENTS
112
122
113
-
**REQUIREMENTS**
114
123
- FreeBSD 9.3-RELEASE amd64 and higher or HardenedBSD/TrueOS
115
124
- ZFS file system
116
125
- Python 3.6+
117
126
- UTF-8 locale (place into your ~/.login_conf):
118
-
```
127
+
128
+
```plain
119
129
me:\
120
130
:charset=UTF-8:\
121
131
:lang=en_US.UTF-8:\
122
132
:setenv=LC_COLLATE=C:
123
133
```
124
-
**Optional**
125
-
- Kernel compiled with:
134
+
135
+
### Optional
136
+
137
+
- Kernel compiled with:
126
138
127
139
# This is optional and only needed if you need VNET
128
140
129
141
options VIMAGE # VNET/Vimage support
130
142
131
-
**Helpful Considerations**
143
+
### Helpful Considerations
144
+
132
145
- For the explanations on jail properties read jail(8)
133
146
- Create bridge0 and bridge1 interfaces for VNET jails to attach to.
134
147
- Use `iocage set` to modify properties and `iocage get` to retrieve property
0 commit comments